dwww Home | Manual pages | Find package

std::geometric_distribution< _Intstd::geometric_distribution< _IntType >(3cxx)

NAME
       std::geometric_distribution< _IntType > - 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)
       template<typename _ForwardIterator , typename
           _UniformRandomNumberGenerator > void __generate (_ForwardIterator
           __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)
       template<typename _ForwardIterator , typename
           _UniformRandomNumberGenerator > void __generate (_ForwardIterator
           __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng,
           const param_type &__p)
       template<typename _UniformRandomNumberGenerator > void __generate
           (result_type *__f, result_type *__t, _UniformRandomNumberGenerator
           &__urng, const param_type &__p)
       result_type max () const
           Returns the least upper bound value of the distribution.
       result_type min () const
           Returns the greatest lower bound value of the distribution.
       template<typename _UniformRandomNumberGenerator > result_type
           operator() (_UniformRandomNumberGenerator &__urng)
           Generating functions.
       template<typename _UniformRandomNumberGenerator > result_type
           operator() (_UniformRandomNumberGenerator &__urng, const param_type
           &__p)
       double p () const
           Returns the distribution parameter p.
       param_type param () const
           Returns the parameter set of the distribution.
       void param (const param_type &__param)
           Sets the parameter set of the distribution.
       void reset ()
           Resets the distribution state.

   Friends
       bool operator== (const geometric_distribution &__d1, const
           geometric_distribution &__d2)
           Return true if two geometric distributions have the same
           parameters.

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) =
       p(1 - p)^{i}$ where $p$ is the parameter of the distribution.

Member Typedef Documentation
   template<typename _IntType  = int> typedef _IntType
       std::geometric_distribution< _IntType >::result_type
       The type of the range of the distribution.

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.

       References std::numeric_limits< _Tp >::max().

   template<typename _IntType  = int> result_type std::geometric_distribution<
       _IntType >::min () const [inline]
       Returns the greatest lower bound value of the distribution.

   template<typename _IntType  = int> template<typename
       _UniformRandomNumberGenerator > result_type
       std::geometric_distribution< _IntType >::operator()
       (_UniformRandomNumberGenerator & __urng) [inline]
       Generating functions.

   template<typename _IntType  = int> double std::geometric_distribution<
       _IntType >::p () const [inline]
       Returns the distribution parameter p.

   template<typename _IntType  = int> param_type std::geometric_distribution<
       _IntType >::param () const [inline]
       Returns the parameter set of the distribution.

       Referenced by std::operator>>().

   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.

   template<typename _IntType  = int> void std::geometric_distribution<
       _IntType >::reset () [inline]
       Resets the distribution state. Does nothing for the geometric
       distribution.

Friends And Related Function Documentation
   template<typename _IntType  = int> bool operator== (const
       geometric_distribution< _IntType > & __d1, const
       geometric_distribution< _IntType > & __d2) [friend]
       Return true if two geometric distributions have the same parameters.

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

libstdc++                       Sstd::geometric_distribution< _IntType >(3cxx)

Generated by dwww version 1.14 on Thu Jan 23 20:44:49 CET 2025.