gem5  v21.1.0.2
random.hh
Go to the documentation of this file.
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 
41 /*
42  * Mersenne twister random number generator.
43  */
44 
45 #ifndef __BASE_RANDOM_HH__
46 #define __BASE_RANDOM_HH__
47 
48 #include <random>
49 #include <string>
50 #include <type_traits>
51 
52 #include "base/compiler.hh"
53 #include "base/types.hh"
54 #include "sim/serialize.hh"
55 
56 namespace gem5
57 {
58 
59 class Checkpoint;
60 
61 class Random : public Serializable
62 {
63 
64  public:
65 
69  std::mt19937_64 gen;
70 
75  Random();
76  Random(uint32_t s); // end of api_base_utils
78  ~Random();
79 
80  void init(uint32_t s);
81 
88  template <typename T>
89  typename std::enable_if_t<std::is_integral<T>::value, T>
91  {
92  // [0, max_value] for integer types
93  std::uniform_int_distribution<T> dist;
94  return dist(gen);
95  }
96 
100  template <typename T>
101  typename std::enable_if_t<std::is_floating_point<T>::value, T>
103  {
104  // [0, 1) for real types
105  std::uniform_real_distribution<T> dist;
106  return dist(gen);
107  }
111  template <typename T>
112  typename std::enable_if_t<std::is_integral<T>::value, T>
113  random(T min, T max)
114  {
115  std::uniform_int_distribution<T> dist(min, max);
116  return dist(gen);
117  }
118 
119  void serialize(CheckpointOut &cp) const override;
120  void unserialize(CheckpointIn &cp) override;
121 };
122 
126 extern Random random_mt;
127 
128 } // namespace gem5
129 
130 #endif // __BASE_RANDOM_HH__
gem5::Random::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: random.cc:73
serialize.hh
gem5::auxv::Random
@ Random
Definition: aux_vector.hh:89
gem5::CheckpointIn
Definition: serialize.hh:68
gem5::Random::~Random
~Random()
Definition: random.cc:62
gem5::Random::gen
std::mt19937_64 gen
Definition: random.hh:69
gem5::statistics::dist
const FlagsType dist
Print the distribution.
Definition: info.hh:66
gem5::Serializable
Basic support for object serialization.
Definition: serialize.hh:169
gem5::Random::random
std::enable_if_t< std::is_integral< T >::value, T > random()
Use the SFINAE idiom to choose an implementation based on whether the type is integral or floating po...
Definition: random.hh:90
gem5::ArmISA::s
Bitfield< 4 > s
Definition: misc_types.hh:561
gem5::Random::random
std::enable_if_t< std::is_integral< T >::value, T > random(T min, T max)
Definition: random.hh:113
compiler.hh
gem5::Random
Definition: random.hh:61
types.hh
gem5::Random::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: random.cc:85
gem5::Random::Random
Random()
Definition: random.cc:51
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::Random::random
std::enable_if_t< std::is_floating_point< T >::value, T > random()
Definition: random.hh:102
gem5::Random::init
void init(uint32_t s)
Definition: random.cc:67
gem5::random_mt
Random random_mt
Definition: random.cc:99

Generated on Tue Sep 21 2021 12:24:57 for gem5 by doxygen 1.8.17