Gaussian distribution.
More...
#include </scratch/bob/jari/tmp/pristine/yat-0.10.x/yat/random/random.h>
List of all members.
Public Member Functions |
| Gaussian (const double s=1, const double m=0) |
| Constructor.
|
double | operator() (void) const |
double | operator() (const double s) const |
double | operator() (const double s, const double m) const |
void | seed (unsigned long s) const |
| Set the seed to s.
|
unsigned long | seed_from_devurandom (void) |
| Set the seed using the /dev/urandom device.
|
Protected Attributes |
RNG * | rng_ |
| pointer to GSL random generator
|
Detailed Description
Gaussian distribution.
Class for generating a random number from a Gaussian distribution between zero and unity. Utilizes the Box-Muller algorithm, which needs two calls to random generator.
Distribution function
Expectation value:
Variance:
Member Typedef Documentation
type returned by operator()
- Since:
- New in yat 0.10
Constructor & Destructor Documentation
theplu::yat::random::Gaussian::Gaussian |
( |
const double |
s = 1 , |
|
|
const double |
m = 0 |
|
) |
| |
|
explicit |
Constructor.
- Parameters:
-
s | is the standard deviation of distribution |
m | is the expectation value of the distribution |
Member Function Documentation
double theplu::yat::random::Gaussian::operator() |
( |
void |
| ) |
const |
|
virtual |
double theplu::yat::random::Gaussian::operator() |
( |
const double |
s | ) |
const |
- Returns:
- A random Gaussian number with standard deviation s and expectation value 0.
- Note:
- this operator ignores parameters given in Constructor
double theplu::yat::random::Gaussian::operator() |
( |
const double |
s, |
|
|
const double |
m |
|
) |
| const |
- Returns:
- A random Gaussian number with standard deviation s and expectation value m.
- Note:
- this operator ignores parameters given in Constructor
void theplu::yat::random::Continuous::seed |
( |
unsigned long |
s | ) |
const |
|
inherited |
Set the seed to s.
Set the seed to s in the underlying rng. If s is zero, a default value from the rng's original implementation is used (cf. GSL documentation).
- Deprecated:
- Provided for backward compatibility with the 0.7 API. Use RNG::instance()->seed(s) instead.
unsigned long theplu::yat::random::Continuous::seed_from_devurandom |
( |
void |
| ) |
|
|
inherited |
The documentation for this class was generated from the following file:
- /scratch/bob/jari/tmp/pristine/yat-0.10.x/yat/random/random.h