LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
Random.cc
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008-2016 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
25 /*
26  * Random number generator implementaion.
27  */
28 
29 #include <limits>
30 #include <string>
31 #include <exception>
32 
33 #include "boost/format.hpp"
34 
35 #include "gsl/gsl_randist.h"
36 
37 #include "lsst/pex/exceptions.h"
38 
39 #include "lsst/afw/math/Random.h"
40 
41 namespace ex = lsst::pex::exceptions;
42 
43 namespace lsst {
44 namespace afw {
45 namespace math {
46 
47 // -- Static data --------
48 
49 ::gsl_rng_type const *const Random::_gslRngTypes[Random::NUM_ALGORITHMS] = {
50  ::gsl_rng_mt19937, ::gsl_rng_ranlxs0, ::gsl_rng_ranlxs1, ::gsl_rng_ranlxs2, ::gsl_rng_ranlxd1,
51  ::gsl_rng_ranlxd2, ::gsl_rng_ranlux, ::gsl_rng_ranlux389, ::gsl_rng_cmrg, ::gsl_rng_mrg,
52  ::gsl_rng_taus, ::gsl_rng_taus2, ::gsl_rng_gfsr4};
53 
54 char const *const Random::_algorithmNames[Random::NUM_ALGORITHMS] = {
55  "MT19937", "RANLXS0", "RANLXS1", "RANLXS2", "RANLXD1", "RANLXD2", "RANLUX",
56  "RANLUX389", "CMRG", "MRG", "TAUS", "TAUS2", "GFSR4"};
57 
58 char const *const Random::_algorithmEnvVarName = "LSST_RNG_ALGORITHM";
59 char const *const Random::_seedEnvVarName = "LSST_RNG_SEED";
60 
61 // -- Private helper functions --------
62 
63 void Random::initialize() {
64  ::gsl_rng *rng = ::gsl_rng_alloc(_gslRngTypes[_algorithm]);
65  if (rng == nullptr) {
66  throw std::bad_alloc();
67  }
68  // This seed is guaranteed to be non-zero.
69  // We want to give a non-zero seed to GSL to avoid it choosing its own.
70  unsigned long int useSeed = _seed == 0 ? std::numeric_limits<unsigned long int>::max() : _seed;
71  ::gsl_rng_set(rng, useSeed);
72  _rng.reset(rng, ::gsl_rng_free);
73 }
74 
75 void Random::initialize(std::string const &algorithm) {
76  // linear search (the number of algorithms is small)
77  for (int i = 0; i < NUM_ALGORITHMS; ++i) {
78  if (_algorithmNames[i] == algorithm) {
79  _algorithm = static_cast<Algorithm>(i);
80  initialize();
81  return;
82  }
83  }
84  throw LSST_EXCEPT(ex::InvalidParameterError, "RNG algorithm " + algorithm + " is not supported");
85 }
86 
87 // -- Constructor --------
88 
89 Random::Random(Algorithm const algorithm, unsigned long seed) : _rng(), _seed(seed), _algorithm(algorithm) {
90  if (_algorithm < 0 || _algorithm >= NUM_ALGORITHMS) {
91  throw LSST_EXCEPT(ex::InvalidParameterError, "Invalid RNG algorithm");
92  }
93  initialize();
94 }
95 
96 Random::Random(std::string const &algorithm, unsigned long seed) : _rng(), _seed(seed) {
97  initialize(algorithm);
98 }
99 
101  Random rng = *this;
102  rng._rng.reset(::gsl_rng_clone(_rng.get()), ::gsl_rng_free);
103  if (!rng._rng) {
104  throw std::bad_alloc();
105  }
106  return rng;
107 }
108 
110  return State(static_cast<char *>(::gsl_rng_state(_rng.get())), getStateSize());
111 }
112 
113 void Random::setState(State const &state) {
114  if (state.size() != getStateSize()) {
115  throw LSST_EXCEPT(
117  (boost::format("Size of given state vector (%d) does not match expected size (%d)") %
118  state.size() % getStateSize())
119  .str());
120  }
121  std::copy(state.begin(), state.end(), static_cast<char *>(::gsl_rng_state(_rng.get())));
122 }
123 
124 std::size_t Random::getStateSize() const { return ::gsl_rng_size(_rng.get()); }
125 
126 // -- Accessors --------
127 
128 Random::Algorithm Random::getAlgorithm() const { return _algorithm; }
129 
130 std::string Random::getAlgorithmName() const { return std::string(_algorithmNames[_algorithm]); }
131 
133  static std::vector<std::string> names;
134  if (names.size() == 0) {
135  for (auto _algorithmName : _algorithmNames) {
136  names.emplace_back(_algorithmName);
137  }
138  }
139  return names;
140 }
141 
142 unsigned long Random::getSeed() const { return _seed; }
143 
144 // -- Mutators: generating random numbers --------
145 
146 double Random::uniform() { return ::gsl_rng_uniform(_rng.get()); }
147 
148 double Random::uniformPos() { return ::gsl_rng_uniform_pos(_rng.get()); }
149 
150 unsigned long Random::uniformInt(unsigned long n) {
151  if (n > ::gsl_rng_max(_rng.get()) - ::gsl_rng_min(_rng.get())) {
152  throw LSST_EXCEPT(ex::RangeError, "Desired random number range exceeds generator range");
153  }
154  return ::gsl_rng_uniform_int(_rng.get(), n);
155 }
156 
157 // -- Mutators: computing random variates for various distributions --------
158 
159 double Random::flat(double const a, double const b) { return ::gsl_ran_flat(_rng.get(), a, b); }
160 
161 double Random::gaussian() { return ::gsl_ran_gaussian_ziggurat(_rng.get(), 1.0); }
162 
163 double Random::chisq(double nu) { return ::gsl_ran_chisq(_rng.get(), nu); }
164 
165 double Random::poisson(double mu) { return ::gsl_ran_poisson(_rng.get(), mu); }
166 } // namespace math
167 } // namespace afw
168 } // namespace lsst
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
table::Key< int > b
table::Key< int > a
T begin(T... args)
A class that can be used to generate sequences of random numbers according to a number of different a...
Definition: Random.h:57
Random(Algorithm algorithm=MT19937, unsigned long seed=1)
Creates a random number generator that uses the given algorithm to produce random numbers,...
Definition: Random.cc:89
Algorithm
Identifiers for the list of supported algorithms.
Definition: Random.h:60
@ NUM_ALGORITHMS
Number of supported algorithms.
Definition: Random.h:92
double uniformPos()
Returns a uniformly distributed random double precision floating point number from the generator.
Definition: Random.cc:148
double chisq(double const nu)
Returns a random variate from the chi-squared distribution with nu degrees of freedom.
Definition: Random.cc:163
Random deepCopy() const
Creates a deep copy of this random number generator.
Definition: Random.cc:100
static std::vector< std::string > const & getAlgorithmNames()
Definition: Random.cc:132
double poisson(double const mu)
Returns a random variate from the poisson distribution with mean mu.
Definition: Random.cc:165
Algorithm getAlgorithm() const
Definition: Random.cc:128
std::string getAlgorithmName() const
Definition: Random.cc:130
unsigned long getSeed() const
Definition: Random.cc:142
double gaussian()
Returns a gaussian random variate with mean 0 and standard deviation 1
Definition: Random.cc:161
void setState(State const &state)
Definition: Random.cc:113
std::string State
Accessors for the opaque state of the random number generator.
Definition: Random.h:154
std::size_t getStateSize() const
Definition: Random.cc:124
State getState() const
Definition: Random.cc:109
double uniform()
Returns a uniformly distributed random double precision floating point number from the generator.
Definition: Random.cc:146
unsigned long uniformInt(unsigned long n)
Returns a uniformly distributed random integer from 0 to n-1.
Definition: Random.cc:150
double flat(double const a, double const b)
Returns a random variate from the flat (uniform) distribution on [a, b).
Definition: Random.cc:159
Reports invalid arguments.
Definition: Runtime.h:66
Reports attempts to exceed implementation-defined length limits for some classes.
Definition: Runtime.h:76
Reports when the result of an operation cannot be represented by the destination type.
Definition: Runtime.h:115
T copy(T... args)
T emplace_back(T... args)
T end(T... args)
T get(T... args)
T max(T... args)
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174
A base class for image defects.
T reset(T... args)
T size(T... args)