Inheritance diagram for std::normal_distribution:

[legend]

Classes

struct param_type

Public Types

typedef _RealType result_type

Public Member Functions

normal_distribution (result_type __mean=result_type(0), result_type __stddev=result_type(1))
normal_distribution (const param_type &__p)
result_type max () const
_RealType mean () const
result_type min () const
template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng)
template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
param_type param () const
void param (const param_type &__param)
void reset ()
_RealType stddev () const

Friends

template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_ostream< _CharT,
_Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &, const std::normal_distribution< _RealType1 > &)
template<typename _RealType1 > bool operator== (const std::normal_distribution< _RealType1 > &__d1, const std::normal_distribution< _RealType1 > &__d2)
template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_istream< _CharT,
_Traits > & operator>> (std::basic_istream< _CharT, _Traits > &, std::normal_distribution< _RealType1 > &)

Detailed Description

A normal continuous distribution for random numbers.

The formula for the normal probability density function is

$p(x|\mu,\sigma) = \frac{1}{\sigma \sqrt{2 \pi}} e^{- \frac{{x - \mu}^ {2}}{2 \sigma ^ {2}} }$

Member Typedef Documentation

typedef _RealType std::normal_distribution::result_type

The type of the range of the distribution.

Definition at line 1979 of file random.h.

Constructor & Destructor Documentation

std::normal_distribution::normal_distribution	(	result_type	__mean = `result_type(0)`,
		result_type	__stddev = `result_type(1)`
	)		`[inline, explicit]`

Constructs a normal distribution with parameters $mean$ and standard deviation.

Definition at line 2017 of file random.h.

Member Function Documentation

result_type std::normal_distribution::max ( ) const [inline]

Returns the least upper bound value of the distribution.

Definition at line 2074 of file random.h.

Referenced by std::normal_distribution< result_type >::max().

_RealType std::normal_distribution::mean ( ) const [inline]

Returns the mean of the distribution.

Definition at line 2038 of file random.h.

result_type std::normal_distribution::min ( ) const [inline]

Returns the greatest lower bound value of the distribution.

Definition at line 2067 of file random.h.

Referenced by std::normal_distribution< result_type >::min().

template<typename _UniformRandomNumberGenerator >

result_type std::normal_distribution::operator() ( _UniformRandomNumberGenerator & __urng ) [inline]

Generating functions.

Definition at line 2082 of file random.h.

Referenced by std::normal_distribution< result_type >::operator()().

template<typename _UniformRandomNumberGenerator >

normal_distribution< _RealType >::result_type std::normal_distribution::operator()	(	_UniformRandomNumberGenerator &	__urng,
		const param_type &	__param
	)

Polar method due to Marsaglia.

Devroye, L. Non-Uniform Random Variates Generation. Springer-Verlag, New York, 1986, Ch. V, Sect. 4.4.

Definition at line 1651 of file random.tcc.

References std::sqrt(), and std::log().

param_type std::normal_distribution::param ( ) const [inline]

Returns the parameter set of the distribution.

Definition at line 2052 of file random.h.

Referenced by std::normal_distribution< result_type >::operator()().

void std::normal_distribution::param ( const param_type & __param ) [inline]

Sets the parameter set of the distribution.

Parameters:

__param The new parameter set of the distribution.

Definition at line 2060 of file random.h.

void std::normal_distribution::reset ( ) [inline]

Resets the distribution state.

Definition at line 2031 of file random.h.

Referenced by std::lognormal_distribution::reset(), std::gamma_distribution< result_type >::reset(), std::student_t_distribution::reset(), std::binomial_distribution::reset(), and std::poisson_distribution::reset().

_RealType std::normal_distribution::stddev ( ) const [inline]

Returns the standard deviation of the distribution.

Definition at line 2045 of file random.h.

Friends And Related Function Documentation

template<typename _RealType1 , typename _CharT , typename _Traits >

std::basic_ostream<_CharT, _Traits>& operator<<	(	std::basic_ostream< _CharT, _Traits > &	,
		const std::normal_distribution< _RealType1 > &
	)		`[friend]`

Inserts a normal_distribution random number distribution __x into the output stream __os.

Parameters:

__os	An output stream.
__x	A normal_distribution random number distribution.

Returns:: The output stream with the state of __x inserted or in an error state.

template<typename _RealType1 >

bool operator==	(	const std::normal_distribution< _RealType1 > &	__d1,
		const std::normal_distribution< _RealType1 > &	__d2
	)		`[friend]`

Return true if two normal distributions have the same parameters and the sequences that would be generated are equal.

template<typename _RealType1 , typename _CharT , typename _Traits >

std::basic_istream<_CharT, _Traits>& operator>>	(	std::basic_istream< _CharT, _Traits > &	,
		std::normal_distribution< _RealType1 > &
	)		`[friend]`

Extracts a normal_distribution random number distribution __x from the input stream __is.

Parameters:

__is	An input stream.
__x	A normal_distribution random number generator engine.

Returns:: The input stream with __x extracted or in an error state.

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