SST::RNG::PoissonDistribution Class Reference

Creates an Poisson distribution for use within SST. More...

#include "sst/core/rng/poisson.h"

Inheritance diagram for SST::RNG::PoissonDistribution:

Public Member Functions
	PoissonDistribution (const double mn)
	Creates an Poisson distribution with a specific lambda.
	PoissonDistribution (const double mn, Random *baseDist)
	Creates an Poisson distribution with a specific lambda and a base random number generator.
	~PoissonDistribution ()
	Destroys the Poisson distribution.
double	getNextDouble () override
	Gets the next (random) double value in the distribution.
double	getLambda ()
	Gets the lambda with which the distribution was created.
	PoissonDistribution ()
	Default constructor.
void	serialize_order (SST::Core::Serialization::serializer &ser) override
	Serialization function for checkpoint.
Public Member Functions inherited from SST::RNG::RandomDistribution
virtual	~RandomDistribution ()
	Destroys the distribution.
	RandomDistribution ()
	Creates the base (abstract) class of a distribution.
virtual void	serialize_order (SST::Core::Serialization::serializer &UNUSED(ser)) override
Public Member Functions inherited from SST::Core::Serialization::serializable_base
virtual const char *	cls_name () const =0
virtual uint32_t	cls_id () const =0
virtual std::string	serialization_name () const =0

Data Fields
ImplementSerializable(PoissonDistribution) protected Random *	baseDistrib
	Serialization macro.
bool	deleteDistrib
	Controls whether the base distribution should be deleted when this class is destructed.

Additional Inherited Members
Static Public Attributes inherited from SST::Core::Serialization::serializable
static constexpr uint32_t	NullClsId = std::numeric_limits<uint32_t>::max()
Static Public Attributes inherited from SST::Core::Serialization::serializable_base
static constexpr uint32_t	NullClsId = std::numeric_limits<uint32_t>::max()
Protected Types inherited from SST::Core::Serialization::serializable_base
enum	cxn_flag_t { ConstructorFlag }
Static Protected Member Functions inherited from SST::Core::Serialization::serializable_base
static void	serializable_abort (uint32_t line, const char *file, const char *func, const char *obj)

Detailed Description

Creates an Poisson distribution for use within SST.

This distribution is the same across platforms and compilers.

Constructor & Destructor Documentation

PoissonDistribution() [1/3]

SST::RNG::PoissonDistribution::PoissonDistribution ( const double mn )

inlineexplicit

Creates an Poisson distribution with a specific lambda.

Parameters

mn	The lambda of the Poisson distribution

References baseDistrib, deleteDistrib, and SST::RNG::RandomDistribution::RandomDistribution().

PoissonDistribution() [2/3]

SST::RNG::PoissonDistribution::PoissonDistribution ( const double mn, Random * baseDist )

inline

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

Parameters

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

References baseDistrib, deleteDistrib, and SST::RNG::RandomDistribution::RandomDistribution().

PoissonDistribution() [3/3]

SST::RNG::PoissonDistribution::PoissonDistribution ( )

inline

Default constructor.

FOR SERIALIZATION ONLY.

References SST::RNG::RandomDistribution::RandomDistribution().

Member Function Documentation

getLambda()

double SST::RNG::PoissonDistribution::getLambda ( )

inline

Gets the lambda with which the distribution was created.

Returns

The lambda which the user created the distribution with

getNextDouble()

double SST::RNG::PoissonDistribution::getNextDouble ( )

inlineoverridevirtual

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

Returns

The next random double from the distribution

Implements SST::RNG::RandomDistribution.

References baseDistrib.

serialize_order()

void SST::RNG::PoissonDistribution::serialize_order ( SST::Core::Serialization::serializer & ser )

inlineoverridevirtual

Serialization function for checkpoint.

Implements SST::Core::Serialization::serializable_base.

References baseDistrib, and deleteDistrib.

Field Documentation

baseDistrib

ImplementSerializable (PoissonDistribution) protected Random* SST::RNG::PoissonDistribution::baseDistrib

Serialization macro.

Sets the lambda of the Poisson distribution. Sets the base random number generator for the distribution.

Referenced by getNextDouble(), PoissonDistribution(), PoissonDistribution(), serialize_order(), and ~PoissonDistribution().

---

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

• src/sst/core/rng/poisson.h