std::normal_distribution(3)

NAME
std::normal_distribution - A normal continuous distribution for random numbers.

SYNOPSIS

  Classes
struct param_type

  Public Types
typedef _RealType result_type

  Public Member Functions
result_type max () const
_RealType mean () const
result_type min () const
normal_distribution (const param_type &__p)
normal_distribution (result_type __mean=result_type(0), result_type __stddev=result_type(1))
template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng)
void param (const param_type &__param)
param_type param () const
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

  template<typename _RealType = double> class std::normal_distribution< _RealType >
A normal continuous distribution for random numbers. The formula for the normal probability density function is $ p(x|,igma) = ac{1}{igma qrt{2 i}} e^{- ac{{x - }^ {2}}{2 igma ^ {2}} } $.

Definition at line 1913 of file bits/random.h.

Member Typedef Documentation

  template<typename _RealType = double> typedef _RealType std::normal_distribution< _RealType >::result_type

The type of the range of the distribution.

Definition at line 1917 of file bits/random.h.

Constructor & Destructor Documentation

  template<typename _RealType = double> std::normal_distribution< _RealType >::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 1955 of file bits/random.h.

Member Function Documentation

  template<typename _RealType = double> result_type std::normal_distribution< _RealType >::max () const [inline]

Returns the least upper bound value of the distribution.

Definition at line 2012 of file bits/random.h.

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

  template<typename _RealType = double> _RealType std::normal_distribution< _RealType >::mean () const [inline]

Returns the mean of the distribution.

Definition at line 1976 of file bits/random.h.

  template<typename _RealType = double> result_type std::normal_distribution< _RealType >::min () const [inline]

Returns the greatest lower bound value of the distribution.

Definition at line 2005 of file bits/random.h.

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

  template<typename _RealType > template<typename _UniformRandomNumberGenerator > normal_distribution< _RealType >::result_type std::normal_distribution< _RealType >::operator() (_UniformRandomNumberGenerator & __urng, const param_type & __param) [inline]

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 1479 of file bits/random.tcc.

References std::log(), std::normal_distribution< _RealType >::normal_distribution::param_type::mean(), std::sqrt(), and std::normal_distribution< _RealType >::normal_distribution::param_type::stddev().

  template<typename _RealType = double> void std::normal_distribution< _RealType >::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 1998 of file bits/random.h.

  template<typename _RealType = double> param_type std::normal_distribution< _RealType >::param () const [inline]

Returns the parameter set of the distribution.

Definition at line 1990 of file bits/random.h.

  template<typename _RealType = double> void std::normal_distribution< _RealType >::reset () [inline]

Resets the distribution state.

Definition at line 1969 of file bits/random.h.

Referenced by std::poisson_distribution< _IntType >::reset(), and std::binomial_distribution< _IntType >::reset().

  template<typename _RealType = double> _RealType std::normal_distribution< _RealType >::stddev () const [inline]

Returns the standard deviation of the distribution.

Definition at line 1983 of file bits/random.h.

Friends And Related Function Documentation

  template<typename _RealType = double> 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 _RealType = double> 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.

  template<typename _RealType = double> 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.

Author

Generated automatically by Doxygen for libstdc++ from the source code.