Provided by: libstdc++-9-doc_9.5.0-3ubuntu1_all bug

NAME

       std::exponential_distribution< _RealType > - An exponential continuous distribution for
       random numbers.

SYNOPSIS

       #include <random.h>

   Classes
       struct param_type

   Public Types
       typedef _RealType result_type

   Public Member Functions
       exponential_distribution ()
           Constructs an exponential distribution with inverse scale parameter 1.0.
       exponential_distribution (_RealType __lambda)
           Constructs an exponential distribution with inverse scale parameter $bda$.
       exponential_distribution (const param_type &__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)
       _RealType lambda () const
           Returns the inverse scale parameter of the distribution.
       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)
       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 exponential_distribution &__d1, const exponential_distribution
           &__d2)
           Return true if two exponential distributions have the same parameters.

Detailed Description

   template<typename _RealType = double>
       class std::exponential_distribution< _RealType >"An exponential continuous distribution
       for random numbers.

       The formula for the exponential probability density function is $p(x|bda) = bda e^{-bda
       x}$.

       Mean$ac{1}{bda}$ Median$ac{}}bda}$ Mode$zero$ Range$[0, infty]$ Standard
       Deviation$ac{1}{bda}$

       Definition at line 4639 of file random.h.

Member Typedef Documentation

   template<typename _RealType  = double> typedef _RealType std::exponential_distribution<
       _RealType >::result_type
       The type of the range of the distribution.

       Definition at line 4646 of file random.h.

Constructor & Destructor Documentation

   template<typename _RealType  = double> std::exponential_distribution< _RealType
       >::exponential_distribution () [inline]
       Constructs an exponential distribution with inverse scale parameter 1.0.

       Definition at line 4683 of file random.h.

   template<typename _RealType  = double> std::exponential_distribution< _RealType
       >::exponential_distribution (_RealType __lambda) [inline],  [explicit]
       Constructs an exponential distribution with inverse scale parameter $bda$.

       Definition at line 4690 of file random.h.

   template<typename _RealType  = double> std::exponential_distribution< _RealType
       >::exponential_distribution (const param_type & __p) [inline],  [explicit]
       Definition at line 4695 of file random.h.

Member Function Documentation

   template<typename _RealType  = double> template<typename _ForwardIterator , typename
       _UniformRandomNumberGenerator > void std::exponential_distribution< _RealType
       >::__generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &
       __urng) [inline]
       Definition at line 4764 of file random.h.

   template<typename _RealType  = double> template<typename _ForwardIterator , typename
       _UniformRandomNumberGenerator > void std::exponential_distribution< _RealType
       >::__generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &
       __urng, const param_type & __p) [inline]
       Definition at line 4771 of file random.h.

   template<typename _RealType  = double> template<typename _UniformRandomNumberGenerator > void
       std::exponential_distribution< _RealType >::__generate (result_type * __f, result_type *
       __t, _UniformRandomNumberGenerator & __urng, const param_type & __p) [inline]
       Definition at line 4778 of file random.h.

   template<typename _RealType  = double> _RealType std::exponential_distribution< _RealType
       >::lambda () const [inline]
       Returns the inverse scale parameter of the distribution.

       Definition at line 4711 of file random.h.

   template<typename _RealType  = double> result_type std::exponential_distribution< _RealType
       >::max () const [inline]
       Returns the least upper bound value of the distribution.

       Definition at line 4740 of file random.h.

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

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

       Definition at line 4733 of file random.h.

   template<typename _RealType  = double> template<typename _UniformRandomNumberGenerator >
       result_type std::exponential_distribution< _RealType >::operator()
       (_UniformRandomNumberGenerator & __urng) [inline]
       Generating functions.

       Definition at line 4748 of file random.h.

       References std::exponential_distribution< _RealType >::operator()().

       Referenced by std::exponential_distribution< _RealType >::operator()().

   template<typename _RealType  = double> template<typename _UniformRandomNumberGenerator >
       result_type std::exponential_distribution< _RealType >::operator()
       (_UniformRandomNumberGenerator & __urng, const param_type & __p) [inline]
       Definition at line 4753 of file random.h.

   template<typename _RealType  = double> param_type std::exponential_distribution< _RealType
       >::param () const [inline]
       Returns the parameter set of the distribution.

       Definition at line 4718 of file random.h.

       Referenced by std::operator>>().

   template<typename _RealType  = double> void std::exponential_distribution< _RealType >::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 4726 of file random.h.

   template<typename _RealType  = double> void std::exponential_distribution< _RealType >::reset
       () [inline]
       Resets the distribution state. Has no effect on exponential distributions.

       Definition at line 4705 of file random.h.

Friends And Related Function Documentation

   template<typename _RealType  = double> bool operator== (const exponential_distribution<
       _RealType > & __d1, const exponential_distribution< _RealType > & __d2) [friend]
       Return true if two exponential distributions have the same parameters.

       Definition at line 4788 of file random.h.

Author

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

libstdc++                                Tue Feb std::exponential_distribution< _RealType >(3cxx)