Ignition Math

API Reference

6.8.0

Random number generator class. More...

#include <ignition/math/Rand.hh>

Static Public Member Functions

static double DblNormal (double _mean=0, double _sigma=1)
 Get a double from a normal distribution. More...
 
static double DblUniform (double _min=0, double _max=1)
 Get a double from a uniform distribution. More...
 
static int32_t IntNormal (int _mean, int _sigma)
 Get an integer from a normal distribution. More...
 
static int32_t IntUniform (int _min, int _max)
 Get an integer from a uniform distribution. More...
 
static void Seed (unsigned int _seed)
 Set the seed value. More...
 
static unsigned int Seed ()
 Get the seed value. More...
 

Detailed Description

Random number generator class.

Member Function Documentation

◆ DblNormal()

static double DblNormal ( double  _mean = 0,
double  _sigma = 1 
)
static

Get a double from a normal distribution.

Parameters
[in]_meanMean value for the distribution
[in]_sigmaSigma value for the distribution

◆ DblUniform()

static double DblUniform ( double  _min = 0,
double  _max = 1 
)
static

Get a double from a uniform distribution.

Parameters
[in]_minMinimum bound for the random number
[in]_maxMaximum bound for the random number

◆ IntNormal()

static int32_t IntNormal ( int  _mean,
int  _sigma 
)
static

Get an integer from a normal distribution.

Parameters
[in]_meanMean value for the distribution
[in]_sigmaSigma value for the distribution

◆ IntUniform()

static int32_t IntUniform ( int  _min,
int  _max 
)
static

Get an integer from a uniform distribution.

Parameters
[in]_minMinimum bound for the random number
[in]_maxMaximum bound for the random number

◆ Seed() [1/2]

static void Seed ( unsigned int  _seed)
static

Set the seed value.

Parameters
[in]_seedThe seed used to initialize the randon number generator.

◆ Seed() [2/2]

static unsigned int Seed ( )
static

Get the seed value.

Returns
The seed value used to initialize the random number generator.

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