libstdc++
Public Types | Public Member Functions | Friends | List of all members
std::geometric_distribution< _IntType, _RealType > Class Template Reference
Discrete Distributions

Public Types

typedef _RealType input_type
 
typedef _IntType result_type
 

Public Member Functions

 geometric_distribution (const _RealType &__p=_RealType(0.5))
 
template<class _UniformRandomNumberGenerator >
geometric_distribution
< _IntType, _RealType >
::result_type 		operator() (_UniformRandomNumberGenerator &__urng)
 
template<class _UniformRandomNumberGenerator >
result_type operator() (_UniformRandomNumberGenerator &__urng)
 
_RealType p () const
 
void reset ()
 

Friends

template<typename _IntType1 , typename _RealType1 , typename _CharT , typename _Traits >
std::basic_ostream< _CharT,
_Traits > & 		operator<< (std::basic_ostream< _CharT, _Traits > &__os, const geometric_distribution< _IntType1, _RealType1 > &__x)
 
template<typename _CharT , typename _Traits >
std::basic_istream< _CharT,
_Traits > & 		operator>> (std::basic_istream< _CharT, _Traits > &__is, geometric_distribution &__x)
 

Detailed Description

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

A discrete geometric random number distribution.

The formula for the geometric probability mass function is $ p(i) = (1 - p)p^{i-1} $ where $ p $ is the parameter of the distribution.

Definition at line 1778 of file tr1_impl/random.

Member Function Documentation

template<typename _IntType = int, typename _RealType = double>
_RealType std::geometric_distribution< _IntType, _RealType >::p ( ) const
inline

Gets the distribution parameter p.

Definition at line 1798 of file tr1_impl/random.

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 geometric_distribution< _IntType1, _RealType1 > &  __x 
)
friend

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

Parameters
__osAn output stream.
__xA geometric_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 _CharT , typename _Traits >
std::basic_istream<_CharT, _Traits>& operator>> ( std::basic_istream< _CharT, _Traits > &  __is,
geometric_distribution< _IntType, _RealType > &  __x 
)
friend

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

Parameters
__isAn input stream.
__xA geometric_distribution random number generator engine.
Returns
The input stream with __x extracted or in an error state.

Definition at line 1835 of file tr1_impl/random.

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