Creates a Gaussian (normal) distribution for which to sample.
More...
#include "sst/core/rng/gaussian.h"
|
| GaussianDistribution (double mn, double sd) |
| Creates a new distribution with a predefined random number generator with a specified mean and standard deviation. More...
|
|
| GaussianDistribution (double mn, double sd, SST::RNG::Random *baseRNG) |
| Creates a new distribution with a predefined random number generator with a specified mean and standard deviation. More...
|
|
| ~GaussianDistribution () |
| Destroys the Gaussian distribution.
|
|
double | getNextDouble () |
| Gets the next double value in the distribution. More...
|
|
double | getMean () |
| Gets the mean of the distribution. More...
|
|
double | getStandardDev () |
| Gets the standard deviation of the distribution. More...
|
|
Public Member Functions inherited from SST::RNG::RandomDistribution |
virtual double | getNextDouble ()=0 |
| Obtains the next double from the distribution. More...
|
|
virtual | ~RandomDistribution () |
| Destroys the distribution.
|
|
| RandomDistribution () |
| Creates the base (abstract) class of a distribution.
|
|
|
double | mean |
| The mean of the Gaussian distribution.
|
|
double | stddev |
| The standard deviation of the Gaussian distribution.
|
|
SST::RNG::Random * | baseDistrib |
| The base random number generator for the distribution.
|
|
double | unusedPair |
| Random numbers for the distribution are read in pairs, this stores the second of the pair.
|
|
bool | usePair |
| Random numbers for the distribution are read in pairs, this tells the code to use the second of the pair.
|
|
bool | deleteDistrib |
| Controls whether the destructor deletes the distribution (we need to ensure we do this IF we created the distribution)
|
|
Creates a Gaussian (normal) distribution for which to sample.
◆ GaussianDistribution() [1/2]
SST::RNG::GaussianDistribution::GaussianDistribution |
( |
double |
mn, |
|
|
double |
sd |
|
) |
| |
|
inline |
Creates a new distribution with a predefined random number generator with a specified mean and standard deviation.
- Parameters
-
mn | The mean of the Gaussian distribution |
sd | The standard deviation of the Gaussian distribution |
References baseDistrib, deleteDistrib, mean, stddev, unusedPair, and usePair.
◆ GaussianDistribution() [2/2]
SST::RNG::GaussianDistribution::GaussianDistribution |
( |
double |
mn, |
|
|
double |
sd, |
|
|
SST::RNG::Random * |
baseRNG |
|
) |
| |
|
inline |
Creates a new distribution with a predefined random number generator with a specified mean and standard deviation.
- Parameters
-
mn | The mean of the Gaussian distribution |
sd | The standard deviation of the Gaussian distribution |
baseRNG | The random number generator as the base of the distribution |
References baseDistrib, deleteDistrib, mean, stddev, unusedPair, and usePair.
◆ getMean()
double SST::RNG::GaussianDistribution::getMean |
( |
| ) |
|
|
inline |
Gets the mean of the distribution.
- Returns
- The mean of the Guassian distribution
References mean.
◆ getNextDouble()
double SST::RNG::GaussianDistribution::getNextDouble |
( |
| ) |
|
|
inlinevirtual |
◆ getStandardDev()
double SST::RNG::GaussianDistribution::getStandardDev |
( |
| ) |
|
|
inline |
Gets the standard deviation of the distribution.
- Returns
- The standard deviation of the Gaussian distribution
References stddev.
The documentation for this class was generated from the following file: