std::geometric_distribution(3)

NAME
std::geometric_distribution - A discrete geometric random number distribution.

SYNOPSIS

  Classes
struct param_type

  Public Types
typedef _IntType result_type

  Public Member Functions
geometric_distribution (const param_type &__p)
geometric_distribution (double __p=0.5)
result_type max () 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)
double p () const
void param (const param_type &__param)
param_type param () const
void reset ()

Detailed Description

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

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

Member Typedef Documentation

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

The type of the range of the distribution.

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

Member Function Documentation

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

Returns the least upper bound value of the distribution.

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

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

Returns the greatest lower bound value of the distribution.

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

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

Returns the distribution parameter p.

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

References std::geometric_distribution< _IntType >::geometric_distribution::param_type::p().

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

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

Returns the parameter set of the distribution.

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

Referenced by std::operator==(), and std::operator>>().

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

Resets the distribution state.

Does nothing for the geometric distribution.

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

Author

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