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

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

Inheritance diagram for SST::RNG::UniformDistribution:

Public Member Functions
	UniformDistribution (const uint32_t probsCount)
	Creates an uniform distribution with a specific number of bins.

	UniformDistribution (const uint32_t probsCount, Random *baseDist)
	Creates a Uniform distribution with a specific number of bins and user supplied random number generator.

	~UniformDistribution ()
	Destroys the distribution and will delete locally allocated RNGs.

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

	UniformDistribution ()
	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(SST::RNG::UniformDistribution) protected const bool	deleteDistrib
	Serialization macro.

const uint32_t	probCount
	Count of discrete probabilities.

double	probPerBin
	Range 0..1 split into discrete bins.

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 a Uniform distribution for use within SST.

This distribution is the same across platforms and compilers.

Constructor & Destructor Documentation

◆ UniformDistribution() [1/3]

SST::RNG::UniformDistribution::UniformDistribution ( const uint32_t probsCount )

inlineexplicit

Creates an uniform distribution with a specific number of bins.

Parameters

probsCount Number of probability bins in this distribution

References deleteDistrib, probCount, probPerBin, and SST::RNG::RandomDistribution::RandomDistribution().

◆ UniformDistribution() [2/3]

SST::RNG::UniformDistribution::UniformDistribution	(	const uint32_t	probsCount,
		Random *	baseDist )

inline

Creates a Uniform distribution with a specific number of bins and user supplied random number generator.

Parameters

probsCount	Number of probability bins in the distribution
baseDist	The base random number generator to take the distribution from.

References deleteDistrib, probCount, probPerBin, and SST::RNG::RandomDistribution::RandomDistribution().

◆ UniformDistribution() [3/3]

SST::RNG::UniformDistribution::UniformDistribution ( )

inline

Default constructor.

FOR SERIALIZATION ONLY.

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

Member Function Documentation

◆ getNextDouble()

double SST::RNG::UniformDistribution::getNextDouble ( )

inlineoverridevirtual

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

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

Implements SST::RNG::RandomDistribution.

References probPerBin.

◆ serialize_order()

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

inlineoverridevirtual

Serialization function for checkpoint.

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

References deleteDistrib, probCount, and probPerBin.

Field Documentation

◆ deleteDistrib

ImplementSerializable (SST::RNG::UniformDistribution) protected const bool SST::RNG::UniformDistribution::deleteDistrib

Serialization macro.

Sets the base random number generator for the distribution. Controls whether the base distribution should be deleted when this class is destructed.

Referenced by serialize_order(), UniformDistribution(), UniformDistribution(), UniformDistribution(), and ~UniformDistribution().

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

src/sst/core/rng/uniform.h

Public Member Functions

Data Fields

Additional Inherited Members