std::poisson_distribution(3)

NAME
std::poisson_distribution - A discrete Poisson random number distribution.

SYNOPSIS

  Classes
struct param_type

  Public Types
typedef _IntType result_type

  Public Member Functions
result_type max () const
double mean () const
result_type min () const
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
poisson_distribution (const param_type &__p)
poisson_distribution (double __mean=1.0)
void reset ()

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

Detailed Description

  template<typename _IntType = int> class std::poisson_distribution< _IntType >
A discrete Poisson random number distribution. The formula for the Poisson probability density function is $ p(i|) = ac{^i}{i!} e^{-} $ where $ $ is the parameter of the distribution.

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

Member Typedef Documentation

  template<typename _IntType = int> typedef _IntType std::poisson_distribution< _IntType >::result_type

The type of the range of the distribution.

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

Member Function Documentation

  template<typename _IntType = int> result_type std::poisson_distribution< _IntType >::max () const [inline]

Returns the least upper bound value of the distribution.

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

Referenced by std::poisson_distribution< _IntType >::operator()().

  template<typename _IntType = int> double std::poisson_distribution< _IntType >::mean () const [inline]

Returns the distribution parameter mean.

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

References std::poisson_distribution< _IntType >::poisson_distribution::param_type::mean().

  template<typename _IntType = int> result_type std::poisson_distribution< _IntType >::min () const [inline]

Returns the greatest lower bound value of the distribution.

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

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

A rejection algorithm when mean >= 12 and a simple method based upon the multiplication of uniform random variates otherwise. NB: The former is available only if _GLIBCXX_USE_C99_MATH_TR1 is defined.

Reference: Devroye, L. 'Non-Uniform Random Variates Generation.' Springer-Verlag, New York, 1986, Ch. X, Sects. 3.3 & 3.4 (+ Errata!).

Definition at line 1006 of file bits/random.tcc.

References std::poisson_distribution< _IntType >::poisson_distribution::param_type::_M_lm_thr, std::abs(), std::log(), std::poisson_distribution< _IntType >::max(), and std::poisson_distribution< _IntType >::poisson_distribution::param_type::mean().

  template<typename _IntType = int> void std::poisson_distribution< _IntType >::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 3599 of file bits/random.h.

  template<typename _IntType = int> param_type std::poisson_distribution< _IntType >::param () const [inline]

Returns the parameter set of the distribution.

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

  template<typename _IntType = int> void std::poisson_distribution< _IntType >::reset () [inline]

Resets the distribution state.

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

References std::normal_distribution< _RealType >::reset().

Friends And Related Function Documentation

  template<typename _IntType = int> template<typename _IntType1 , typename _CharT , typename _Traits > std::basic_ostream<_CharT, _Traits>& operator<< (std::basic_ostream< _CharT, _Traits > &, const std::poisson_distribution< _IntType1 > &) [friend]

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

Parameters:
    __os An output stream.
    __x A poisson_distribution random number distribution.

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

  template<typename _IntType = int> template<typename _IntType1 > bool operator== (const std::poisson_distribution< _IntType1 > & __d1, const std::poisson_distribution< _IntType1 > & __d2) [friend]

Return true if two Poisson distributions have the same parameters.

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

  template<typename _IntType = int> template<typename _IntType1 , typename _CharT , typename _Traits > std::basic_istream<_CharT, _Traits>& operator>> (std::basic_istream< _CharT, _Traits > &, std::poisson_distribution< _IntType1 > &) [friend]

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

Parameters:
    __is An input stream.
    __x A poisson_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.