SST  14.1.0
StructuralSimulationToolkit
SST::RNG::ConstantDistribution Class Reference

Implements a distribution which always returns a constant value (provided by the user). More...

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

Inheritance diagram for SST::RNG::ConstantDistribution:
SST::RNG::RandomDistribution SST::Core::Serialization::serializable SST::Core::Serialization::serializable_base

Public Member Functions

 ConstantDistribution (double v)
 Creates a constant distribution which returns a constant value. More...
 
 ~ConstantDistribution ()
 Destroys the constant distribution.
 
double getNextDouble () override
 Gets the next double for the distribution, in this case it will return the constant value specified by the user. More...
 
double getMean ()
 Gets the constant value for the distribution. More...
 
 ConstantDistribution ()
 Default constructor. More...
 
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
 

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

Implements a distribution which always returns a constant value (provided by the user).

This can be used in situations where the user may not want to apply a distribution.

Constructor & Destructor Documentation

◆ ConstantDistribution() [1/2]

SST::RNG::ConstantDistribution::ConstantDistribution ( double  v)
inline

Creates a constant distribution which returns a constant value.

Parameters
vIs the constant value the user wants returned by the distribution

◆ ConstantDistribution() [2/2]

SST::RNG::ConstantDistribution::ConstantDistribution ( )
inline

Default constructor.

FOR SERIALIZATION ONLY.

Member Function Documentation

◆ getMean()

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

Gets the constant value for the distribution.

Returns
Constant value specified by the user when creating the class

◆ getNextDouble()

double SST::RNG::ConstantDistribution::getNextDouble ( )
inlineoverridevirtual

Gets the next double for the distribution, in this case it will return the constant value specified by the user.

Returns
Constant value specified by the user when creating the class

Implements SST::RNG::RandomDistribution.


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