MaCh3  2.8.0
Reference Guide
Classes | Functions
M3::rand Namespace Reference

Classes

class  Random
 Universal random number generator for MaCh3. More...
 

Functions

void SetSeed (const std::uint64_t seed)
 Set the global random seed. More...
 
double Uniform (const double min=0.0, const double max=1.0)
 Generate a uniform random number in [min, max). More...
 
int Poisson (const double mean)
 Generate a Poisson-distributed integer with the given mean. More...
 
double PoissonD (const double mean)
 Generate a Poisson-distributed random number with the given mean. More...
 
int UniformInt (const int min, const int max)
 Generate a uniform random integer in [min, max]. More...
 
double Gaus (const double mean=0.0, const double sigma=1.0)
 Generate a Gaussian random number. More...
 

Function Documentation

◆ Gaus()

double M3::rand::Gaus ( const double  mean = 0.0,
const double  sigma = 1.0 
)
inline

Generate a Gaussian random number.

Definition at line 137 of file Random.h.

138  {
139  return Random::Instance().Gaus(mean, sigma);
140  }

◆ Poisson()

int M3::rand::Poisson ( const double  mean)
inline

Generate a Poisson-distributed integer with the given mean.

Definition at line 122 of file Random.h.

122  {
123  return Random::Instance().Poisson(mean);
124  }

◆ PoissonD()

double M3::rand::PoissonD ( const double  mean)
inline

Generate a Poisson-distributed random number with the given mean.

Definition at line 127 of file Random.h.

127  {
128  return Random::Instance().PoissonD(mean);
129  }

◆ SetSeed()

void M3::rand::SetSeed ( const std::uint64_t  seed)
inline

Set the global random seed.

Definition at line 111 of file Random.h.

111  {
112  Random::Instance().SetSeed(seed);
113  }

◆ Uniform()

double M3::rand::Uniform ( const double  min = 0.0,
const double  max = 1.0 
)
inline

Generate a uniform random number in [min, max).

Definition at line 116 of file Random.h.

117  {
118  return Random::Instance().Uniform(min, max);
119  }

◆ UniformInt()

int M3::rand::UniformInt ( const int  min,
const int  max 
)
inline

Generate a uniform random integer in [min, max].

Definition at line 132 of file Random.h.

132  {
133  return Random::Instance().UniformInt(min, max);
134  }