queso-0.56.0
RngBoost.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------bl-
2 //--------------------------------------------------------------------------
3 //
4 // QUESO - a library to support the Quantification of Uncertainty
5 // for Estimation, Simulation and Optimization
6 //
7 // Copyright (C) 2008-2015 The PECOS Development Team
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the Version 2.1 GNU Lesser General
11 // Public License as published by the Free Software Foundation.
12 //
13 // This library is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // Lesser General Public License for more details.
17 //
18 // You should have received a copy of the GNU Lesser General Public
19 // License along with this library; if not, write to the Free Software
20 // Foundation, Inc. 51 Franklin Street, Fifth Floor,
21 // Boston, MA 02110-1301 USA
22 //
23 //-----------------------------------------------------------------------el-
24 
25 #ifndef UQ_RNG_BOOST_H
26 #define UQ_RNG_BOOST_H
27 
28 #include <queso/RngBase.h>
29 #include <boost/random/mersenne_twister.hpp>
30 
31 
44 namespace QUESO {
45 
46 class RngBoost : public RngBase
47 {
48 public:
50 
51  RngBoost(int seed, int worldRank);
53 
55  ~RngBoost();
57 
59 
60  void resetSeed (int newSeed);
62 
63 
65 
69  double uniformSample () const;
70 
71 
74 
80  double gaussianSample(double stdDev) const;
81 
83 
88  double betaSample (double alpha, double beta) const;
89 
91 
97  double gammaSample (double a, double b) const;
98 
99 private:
101  RngBoost();
102 
104 
109  boost::mt19937 m_rng; // it cannot be static, as it is not initialized yet
110 };
111 
112 } // End namespace QUESO
113 
114 #endif // UQ_RNG_BOOST_H
double gaussianSample(double stdDev) const
Definition: RngBoost.C:71
double betaSample(double alpha, double beta) const
Samples a value from a Beta distribution. Support: [0,1].
Definition: RngBoost.C:81
boost::mt19937 m_rng
Random number generator from class boost::mt19937.
Definition: RngBoost.h:109
double uniformSample() const
Samples a value from a uniform distribution. Support: [0,1] or [a,b].
Definition: RngBoost.C:63
RngBoost()
Default Constructor: it should not be used.
Class for random number generation (base class for either GSL or Boost RNG).
Definition: RngBase.h:45
~RngBoost()
Destructor.
Definition: RngBoost.C:47
double gammaSample(double a, double b) const
Samples a value from a Gamma distribution. Support: [0,infinity).
Definition: RngBoost.C:90
int seed() const
Sets the seed.
Definition: RngBase.C:42
void resetSeed(int newSeed)
Resets the seed with value newSeed.
Definition: RngBoost.C:54

Generated on Tue Nov 29 2016 10:53:10 for queso-0.56.0 by  doxygen 1.8.5