SST  7.2.0 StructuralSimulationToolkit
SST::RNG::SSTGaussianDistribution Class Reference

Creates a Gaussian (normal) distribution for which to sample. More...

`#include "sst/core/rng/gaussian.h"`

Inheritance diagram for SST::RNG::SSTGaussianDistribution:

## Public Member Functions

SSTGaussianDistribution (double mn, double sd)
Creates a new distribution with a predefined random number generator with a specified mean and standard deviation. More...

SSTGaussianDistribution (double mn, double sd, SSTRandom *baseRNG)
Creates a new distribution with a predefined random number generator with a specified mean and standard deviation. More...

~SSTGaussianDistribution ()
Destroys the Gaussian distribution.

double getNextDouble ()
Gets the next double value in the distributon. 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::SSTRandomDistribution
virtual ~SSTRandomDistribution ()
Destroys the distribution.

SSTRandomDistribution ()
Creates the base (abstract) class of a distribution.

## Protected Attributes

double mean
The mean of the Gaussian distribution.

double stddev
The standard deviation of the Gaussian distribution.

SSTRandombaseDistrib
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)

## Detailed Description

Creates a Gaussian (normal) distribution for which to sample.

## ◆ SSTGaussianDistribution() [1/2]

 SST::RNG::SSTGaussianDistribution::SSTGaussianDistribution ( 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

## ◆ SSTGaussianDistribution() [2/2]

 SST::RNG::SSTGaussianDistribution::SSTGaussianDistribution ( double mn, double sd, SSTRandom * 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

## ◆ getMean()

 double SST::RNG::SSTGaussianDistribution::getMean ( )
inline

Gets the mean of the distribution.

Returns
The mean of the Guassian distribution

## ◆ getNextDouble()

 double SST::RNG::SSTGaussianDistribution::getNextDouble ( )
inlinevirtual

Gets the next double value in the distributon.

Returns
The next double value of the distribution (in this case a Gaussian distribution)

Implements SST::RNG::SSTRandomDistribution.

## ◆ getStandardDev()

 double SST::RNG::SSTGaussianDistribution::getStandardDev ( )
inline

Gets the standard deviation of the distribution.

Returns
The standard deviation of the Gaussian distribution

The documentation for this class was generated from the following file: