yat  0.20.3pre
Public Types | Public Member Functions | Protected Attributes | List of all members
theplu::yat::random::ContinuousGeneral Class Reference

Generates numbers from a histogram in a continuous manner. More...

#include <yat/random/random.h>

Inheritance diagram for theplu::yat::random::ContinuousGeneral:
theplu::yat::random::Continuous

Public Types

typedef double result_type
 

Public Member Functions

 ContinuousGeneral (const statistics::Histogram &hist)
 Constructor. More...
 
double operator() (void) const
 
void seed (unsigned long s) const
 Set the seed to s. More...
 
unsigned long seed_from_devurandom (void)
 Set the seed using the /dev/urandom device. More...
 

Protected Attributes

RNGrng_
 pointer to GSL random generator
 

Detailed Description

Generates numbers from a histogram in a continuous manner.

Member Typedef Documentation

◆ result_type

type returned by operator()

Since
New in yat 0.10

Constructor & Destructor Documentation

◆ ContinuousGeneral()

theplu::yat::random::ContinuousGeneral::ContinuousGeneral ( const statistics::Histogram hist)
explicit

Constructor.

Parameters
histis a Histogram defining the probability distribution

Member Function Documentation

◆ operator()()

double theplu::yat::random::ContinuousGeneral::operator() ( void  ) const
virtual

The number is generated in a two step process. First the bin in the histogram is randomly selected (see DiscreteGeneral). Then a number is generated uniformly from the interval defined by the bin.

Returns
A random number.

Implements theplu::yat::random::Continuous.

◆ seed()

void theplu::yat::random::Continuous::seed ( unsigned long  s) const
inherited

Set the seed to s.

Set the seed to s in the underlying rng. If s is zero, a default value from the rng's original implementation is used (cf. GSL documentation).

Deprecated:
Provided for backward compatibility with the 0.7 API. Use RNG::instance()->seed(s) instead.

◆ seed_from_devurandom()

unsigned long theplu::yat::random::Continuous::seed_from_devurandom ( void  )
inherited

Set the seed using the /dev/urandom device.

Returns
The seed acquired from /dev/urandom.
Deprecated:
Provided for backward compatibility with the 0.7 API. Use RNG::instance()->seed_from_devurandom() instead.

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

Generated on Sat Feb 18 2023 03:31:45 for yat by  doxygen 1.8.14