ParameterDistributionUniform Class Reference

CPP API: mio::ParameterDistributionUniform Class Reference
mio::ParameterDistributionUniform Class Reference

#include <parameter_distributions.h>

Inheritance diagram for mio::ParameterDistributionUniform:
Collaboration diagram for mio::ParameterDistributionUniform:

Public Member Functions

ParameterDistributionclone () const override
 
ScalarType get_lower_bound () const
 
ScalarType get_rand_sample (abm::PersonalRandomNumberGenerator &rng) override
 
ScalarType get_rand_sample (RandomNumberGenerator &rng) override
 
ScalarType get_upper_bound () const
 
 ParameterDistributionUniform (ScalarType lower_bound, ScalarType upper_bound)
 
std::vector< ScalarTypeparams () const override
 
template<class RNG >
ScalarType sample (RNG &rng)
 
template<class IOContext >
void serialize (IOContext &io) const
 
template<class IOObject >
void serialize_elements (IOObject &obj) const
 
bool smaller_impl (const ParameterDistribution &other) const override
 
- Public Member Functions inherited from mio::Visitable< Derived, Base, Visitor, ConstVisitor >
void accept (ConstVisitor &visitor) const
 
void accept (Visitor &visitor)
 

Static Public Member Functions

template<class IOContext >
static IOResult< ParameterDistributionUniformdeserialize (IOContext &io)
 
template<class IOContext , class IOObject >
static IOResult< ParameterDistributionUniformdeserialize_elements (IOContext &io, IOObject &obj)
 

Private Attributes

UniformDistribution< ScalarType >::ParamType m_distribution
 
ScalarType m_lower_bound
 
ScalarType m_upper_bound
 

Constructor & Destructor Documentation

◆ ParameterDistributionUniform()

mio::ParameterDistributionUniform::ParameterDistributionUniform ( ScalarType  lower_bound,
ScalarType  upper_bound 
)
inline

Member Function Documentation

◆ clone()

ParameterDistribution* mio::ParameterDistributionUniform::clone ( ) const
inlineoverride

◆ deserialize()

template<class IOContext >
static IOResult<ParameterDistributionUniform> mio::ParameterDistributionUniform::deserialize ( IOContext &  io)
inlinestatic

◆ deserialize_elements()

template<class IOContext , class IOObject >
static IOResult<ParameterDistributionUniform> mio::ParameterDistributionUniform::deserialize_elements ( IOContext &  io,
IOObject &  obj 
)
inlinestatic

◆ get_lower_bound()

ScalarType mio::ParameterDistributionUniform::get_lower_bound ( ) const
inline

◆ get_rand_sample() [1/2]

ScalarType mio::ParameterDistributionUniform::get_rand_sample ( abm::PersonalRandomNumberGenerator rng)
inlineoverride

◆ get_rand_sample() [2/2]

ScalarType mio::ParameterDistributionUniform::get_rand_sample ( RandomNumberGenerator &  rng)
inlineoverride

◆ get_upper_bound()

ScalarType mio::ParameterDistributionUniform::get_upper_bound ( ) const
inline

◆ params()

std::vector<ScalarType> mio::ParameterDistributionUniform::params ( ) const
inlineoverride

◆ sample()

template<class RNG >
ScalarType mio::ParameterDistributionUniform::sample ( RNG &  rng)
inline

◆ serialize()

template<class IOContext >
void mio::ParameterDistributionUniform::serialize ( IOContext &  io) const
inline

◆ serialize_elements()

template<class IOObject >
void mio::ParameterDistributionUniform::serialize_elements ( IOObject &  obj) const
inline

◆ smaller_impl()

bool mio::ParameterDistributionUniform::smaller_impl ( const ParameterDistribution other) const
inlineoverride

Member Data Documentation

◆ m_distribution

UniformDistribution<ScalarType>::ParamType mio::ParameterDistributionUniform::m_distribution
private

◆ m_lower_bound

ScalarType mio::ParameterDistributionUniform::m_lower_bound
private

◆ m_upper_bound

ScalarType mio::ParameterDistributionUniform::m_upper_bound
private