SST 12.1.0 Structural Simulation Toolkit
SST::RNG::DiscreteDistribution Class Reference

Creates a discrete distribution for use within SST. More...

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

Inheritance diagram for SST::RNG::DiscreteDistribution:

Public Member Functions

DiscreteDistribution (const double *probs, const uint32_t probsCount)
Creates an exponential distribution with a specific lambda. More...

DiscreteDistribution (const double *probs, const uint32_t probsCount, SST::RNG::Random *baseDist)
Creates an exponential distribution with a specific lambda and a base random number generator. More...

~DiscreteDistribution ()
Destroys the exponential distribution.

double getNextDouble ()
Gets the next (random) double value in 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.

Protected Attributes

SST::RNG::RandombaseDistrib
Sets the base random number generator for the distribution.

bool deleteDistrib
Controls whether the base distribution should be deleted when this class is destructed.

double * probabilities
The discrete probability list.

uint32_t probCount
Count of discrete probabilities.

Detailed Description

Creates a discrete distribution for use within SST.

This distribution is the same across platforms and compilers.

◆ DiscreteDistribution() [1/2]

 SST::RNG::DiscreteDistribution::DiscreteDistribution ( const double * probs, const uint32_t probsCount )
inline

Creates an exponential distribution with a specific lambda.

Parameters
 lambda The lambda of the exponential distribution

References baseDistrib, deleteDistrib, and probabilities.

◆ DiscreteDistribution() [2/2]

 SST::RNG::DiscreteDistribution::DiscreteDistribution ( const double * probs, const uint32_t probsCount, SST::RNG::Random * baseDist )
inline

Creates an exponential distribution with a specific lambda and a base random number generator.

Parameters
 lambda The lambda of the exponential distribution baseDist The base random number generator to take the distribution from.

References baseDistrib, deleteDistrib, and probabilities.

◆ getNextDouble()

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

Gets the next (random) double value in the distribution.

Returns
The next random double from the discrete distribution, this is the double converted of the index where the probability is located

Implements SST::RNG::RandomDistribution.

References baseDistrib, SST::RNG::Random::nextUniform(), probabilities, and probCount.

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