std::poisson_distribution

std::poisson_distribution< _IntType, _RealType > Class Template Reference
[Discrete Distributions]

List of all members.

Detailed Description

template<typename _IntType = int, typename _RealType = double>
class std::poisson_distribution< _IntType, _RealType >

A discrete Poisson random number distribution.

The formula for the Poisson probability mass function is $ p(i) = \frac{mean^i}{i!} e^{-mean} $ where $ mean $ is the parameter of the distribution.

Definition at line 1804 of file tr1_impl/random.

Public Types

Public Member Functions

Friends

Member Function Documentation

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

Gets the distribution parameter mean.

Definition at line 1824 of file tr1_impl/random.

template<typename _IntType, typename _RealType>
template<class _UniformRandomNumberGenerator>
poisson_distribution< _IntType, _RealType >::result_type std::poisson_distribution< _IntType, _RealType >::operator() ( _UniformRandomNumberGenerator &  __urng  ) 

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 941 of file random.tcc.

References _GLIBCXX_TR1, std::abs(), std::ceil(), std::numeric_limits< _Tp >::epsilon(), std::floor(), std::log(), and std::numeric_limits< _Tp >::max().

Friends And Related Function Documentation

template<typename _IntType = int, typename _RealType = double>
template<typename _IntType1, typename _RealType1, typename _CharT, typename _Traits>
std::basic_ostream<_CharT, _Traits>& operator<< ( std::basic_ostream< _CharT, _Traits > &  __os,
const poisson_distribution< _IntType1, _RealType1 > &  __x 
) [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, typename _RealType = double>
template<typename _IntType1, typename _RealType1, typename _CharT, typename _Traits>
std::basic_istream<_CharT, _Traits>& operator>> ( std::basic_istream< _CharT, _Traits > &  __is,
poisson_distribution< _IntType1, _RealType1 > &  __x 
) [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.

The documentation for this class was generated from the following files:
Generated on Wed Mar 26 00:44:49 2008 for libstdc++ by  doxygen 1.5.1