CosmoBolognaLib
Free Software C++/Python libraries for cosmological calculations
cbl::random::ConstantRandomNumbers Class Reference

The class ConstantRandomNumbers. More...

#include <RandomNumbers.h>

Inheritance diagram for cbl::random::ConstantRandomNumbers:
Collaboration diagram for cbl::random::ConstantRandomNumbers:

Public Member Functions

 ConstantRandomNumbers (const double value)
 constructor More...
 
 ~ConstantRandomNumbers ()=default
 default destructor
 
void set_value (const double value)
 set the value for constant distribution More...
 
double operator() ()
 extract number from the distribution More...
 
- Public Member Functions inherited from cbl::random::RandomNumbers
 RandomNumbers ()=default
 default constructor
 
 RandomNumbers (const int seed, const double MinVal=par::defaultDouble, const double MaxVal=-par::defaultDouble)
 constructor More...
 
virtual ~RandomNumbers ()=default
 default destructor
 
void set_seed (const int seed)
 set the random number generator seed More...
 
void set_range (const double MinVal, const double MaxVal)
 set the range for the random number extraction More...
 
void set_value (const double value)
 set the value for constant distribution More...
 
virtual void set_mean (const double mean)
 set the mean for Poisson distribution More...
 
virtual void set_mean_sigma (const double mean, const double sigma)
 set parameters for Normal distribution More...
 
virtual void set_discrete_values (const std::vector< double > values, const std::vector< double > weights)
 set parameters for Discrete distribution More...
 
virtual void set_interpolated_distribution (const std::vector< double > values, const std::vector< double > weights)
 set the parameters for the interpolated distribution More...
 
virtual void set_custom_distribution (const distribution_func func, const std::shared_ptr< void > modelInput, const std::vector< double > parameter)
 set parameters for interpolated distribution More...
 

Protected Attributes

double m_value
 returned value
 
- Protected Attributes inherited from cbl::random::RandomNumbers
std::mt19937_64 m_generator
 pseudo-random numbers generator
 
int m_seed
 seed
 
double m_MinVal
 minimum value to generate
 
double m_MaxVal
 maximum value to generate
 

Detailed Description

The class ConstantRandomNumbers.

"Headers/RandomNumbers.h"

This class return always the same value, written for consistency

Definition at line 201 of file RandomNumbers.h.

Constructor & Destructor Documentation

◆ ConstantRandomNumbers()

cbl::random::ConstantRandomNumbers::ConstantRandomNumbers ( const double  value)
inline

constructor

Parameters
valuethe value to be returned

Definition at line 214 of file RandomNumbers.h.

Member Function Documentation

◆ operator()()

double cbl::random::ConstantRandomNumbers::operator() ( )
inlinevirtual

extract number from the distribution

Returns
random values

Implements cbl::random::RandomNumbers.

Definition at line 235 of file RandomNumbers.h.

◆ set_value()

void cbl::random::ConstantRandomNumbers::set_value ( const double  value)
inline

set the value for constant distribution

Parameters
valuethe value to be returned

Definition at line 228 of file RandomNumbers.h.


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