random.hh revision 10905 
1/*
2 * Copyright (c) 2014 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2003-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Nathan Binkert
41 *          Ali Saidi
42 *          Andreas Hansson
43 */
44
45/*
46 * Mersenne twister random number generator.
47 */
48
49#ifndef __BASE_RANDOM_HH__
50#define __BASE_RANDOM_HH__
51
52#include <random>
53#include <string>
54#include <type_traits>
55
56#include "base/compiler.hh"
57#include "base/types.hh"
58#include "sim/serialize.hh"
59
60class Checkpoint;
61
62class Random : public Serializable
63{
64
65  private:
66
67    std::mt19937_64 gen;
68
69  public:
70
71    Random();
72    Random(uint32_t s);
73    ~Random();
74
75    void init(uint32_t s);
76
77    /**
78     * Use the SFINAE idiom to choose an implementation based on
79     * whether the type is integral or floating point.
80     */
81    template <typename T>
82    typename std::enable_if<std::is_integral<T>::value, T>::type
83    random()
84    {
85        // [0, max_value] for integer types
86        std::uniform_int_distribution<T> dist;
87        return dist(gen);
88    }
89
90    template <typename T>
91    typename std::enable_if<std::is_floating_point<T>::value, T>::type
92    random()
93    {
94        // [0, 1) for real types
95        std::uniform_real_distribution<T> dist;
96        return dist(gen);
97    }
98
99    template <typename T>
100    typename std::enable_if<std::is_integral<T>::value, T>::type
101    random(T min, T max)
102    {
103        std::uniform_int_distribution<T> dist(min, max);
104        return dist(gen);
105    }
106
107    void serialize(CheckpointOut &cp) const M5_ATTR_OVERRIDE;
108    void unserialize(CheckpointIn &cp) M5_ATTR_OVERRIDE;
109};
110
111extern Random random_mt;
112
113#endif // __BASE_RANDOM_HH__
114