honey::Uniform_< Real > Class Template Reference

Generate a random variate between min and max non-inclusive with uniform (flat) distribution. More...

#include <Dist.h>

Inheritance diagram for honey::Uniform_< Real >:

Collaboration diagram for honey::Uniform_< Real >:

Public Member Functions
	Uniform_ (RandomGen &gen)
	Uniform_ (RandomGen &gen, Real min, Real max)
virtual Real	next () const
	Get next randomly distributed variate. Requires a random generator (see ctor or setGen()) More...
virtual Real	pdf (Real x) const
	Probability Density Function. More...
virtual Real	cdf (Real x) const
	Cumulative Distribution Function. More...
virtual Real	cdfInv (Real P) const
	Inverse of the CDF. More...
virtual Real	mean () const
	Calc mean. More...
virtual Real	variance () const
	Calc variance. More...
Public Member Functions inherited from honey::RandomDist< Real >
	RandomDist (optional< RandomGen & > gen=optnull)
	Construct with a random generator to use for next() More...
virtual	~RandomDist ()
virtual Real	cdfComp (Real x) const
	Complement of the CDF. More...
Real	stdDev () const
	Calc standard deviation. More...
void	setGen (RandomGen &gen)
	Set random generator to use for next() More...
RandomGen &	getGen () const
	Get random generator. More...

Static Public Member Functions
static Real	nextStd (RandomGen &gen)
	Static function for standard distribution. Generate random real variate between 0 and 1 non-inclusive. More...

Public Attributes
Real	min
Real	max

Additional Inherited Members
Protected Types inherited from honey::RandomDist< Real >
typedef Numeral< Real >::Real_	Real_
typedef Real_::DoubleType	Double_
typedef Double_::Real	Double
typedef Alge_< Real >	Alge
typedef Alge_< Double >	Alge_d
typedef Uniform_< Double >	Uniform
Protected Member Functions inherited from honey::RandomDist< Real >
Real	cdfInvFind (Real P, Real min, Real max, bool discrete=false) const
	Generic binary search algorithm to find Cdf. More...

Detailed Description

template<class Real>
class honey::Uniform_< Real >

Generate a random variate between min and max non-inclusive with uniform (flat) distribution.

This is a uniform distribution, so every value in range (min, max) has equal chance. Construct without arguments to generate variates within range (0, 1) non-inclusive

Parameters

min	Minimum value. Range [-inf, inf]
max	Maximum value. Range [-inf, inf]

Return values

x	Random variate. Range (min, max) non-inclusive

Constructor & Destructor Documentation

template<class Real >

honey::Uniform_< Real >::Uniform_ ( RandomGen &  gen )

inline

template<class Real >

honey::Uniform_< Real >::Uniform_ ( RandomGen &  gen, Real  min, Real  max  )

inline

Member Function Documentation

template<class Real >

virtual Real honey::Uniform_< Real >::cdf ( Real  x ) const

inlinevirtual

Cumulative Distribution Function.

The integral of the PDF from -inf to x.

Parameters

x	value, range depends on distribution.

Return values

P	a probability in range [0,1] that a random variate will be <= x.

Reimplemented from honey::RandomDist< Real >.

template<class Real >

virtual Real honey::Uniform_< Real >::cdfInv ( Real  P ) const

inlinevirtual

Inverse of the CDF.

Parameters

P	cumulative probability

Return values

x	A value that has probability P of being >= a random variate X. Also, x satisfies: cdf(x) = P.

Reimplemented from honey::RandomDist< Real >.

template<class Real >

virtual Real honey::Uniform_< Real >::mean ( ) const

inlinevirtual

Calc mean.

Reimplemented from honey::RandomDist< Real >.

template<class Real >

virtual Real honey::Uniform_< Real >::next ( ) const

inlinevirtual

Get next randomly distributed variate. Requires a random generator (see ctor or setGen())

Reimplemented from honey::RandomDist< Real >.

template<class Real >

static Real honey::Uniform_< Real >::nextStd ( RandomGen &  gen )

inlinestatic

Static function for standard distribution. Generate random real variate between 0 and 1 non-inclusive.

template<class Real >

virtual Real honey::Uniform_< Real >::pdf ( Real  x ) const

inlinevirtual

Probability Density Function.

The PDF integrates to 1 over the entire range of possible values of x.

Parameters

x	value, range depends on distribution.

Return values

p	a relative likelihood in range [0,inf] that a random variate X will equal x.

Reimplemented from honey::RandomDist< Real >.

template<class Real >

virtual Real honey::Uniform_< Real >::variance ( ) const

inlinevirtual

Calc variance.

Reimplemented from honey::RandomDist< Real >.

Member Data Documentation

template<class Real >

Real honey::Uniform_< Real >::max

template<class Real >

Real honey::Uniform_< Real >::min

---

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

• src/common/Honey/Math/Random/Dist/Dist.h
• src/common/Honey/Math/Random/Dist/Uniform.h