logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

std::poisson_distribution< _IntType > - A discrete Poisson random number distribution.

Author

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

                                                    libstdc++        std::poisson_distribution<_IntType>(3cxx)

Detailed Description

template<typename_IntType=int>
       class std::poisson_distribution< _IntType >"A discrete Poisson random number distribution.

       The formula for the Poisson probability density function is $p(i|) = ac{^i}{i!} e^{-}$ where $$ is the
       parameter of the distribution.

       Since
           C++11

Member Function Documentation

template<typename_IntType=int>result_typestd::poisson_distribution<_IntType>::max()const[inline]
       Returns the least upper bound value of the distribution.

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

   template<typename_IntType=int>doublestd::poisson_distribution<_IntType>::mean()const[inline]
       Returns the distribution parameter mean.

   template<typename_IntType=int>result_typestd::poisson_distribution<_IntType>::min()const[inline]
       Returns the greatest lower bound value of the distribution.

   template<typename_IntType=int>template<typename_UniformRandomNumberGenerator>result_typestd::poisson_distribution<_IntType>::operator()(_UniformRandomNumberGenerator&__urng)[inline]
       Generating functions.

       References std::poisson_distribution<_IntType>::operator()().

       Referenced by std::poisson_distribution<_IntType>::operator()().

   template<typename_IntType>template<typename_UniformRandomNumberGenerator>poisson_distribution<_IntType>::result_typestd::poisson_distribution<_IntType>::operator()(_UniformRandomNumberGenerator&__urng,constparam_type&__param)
       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!).

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

   template<typename_IntType=int>param_typestd::poisson_distribution<_IntType>::param()const[inline]
       Returns the parameter set of the distribution.

   template<typename_IntType=int>voidstd::poisson_distribution<_IntType>::param(constparam_type&__param)[inline]
       Sets the parameter set of the distribution.

       Parameters__param The new parameter set of the distribution.

   template<typename_IntType=int>voidstd::poisson_distribution<_IntType>::reset()[inline]
       Resets the distribution state.

       References std::normal_distribution<_RealType>::reset().

Member Typedef Documentation

template<typename_IntType=int>typedef_IntTypestd::poisson_distribution<_IntType>::result_type
       The type of the range of the distribution.

Name

       std::poisson_distribution< _IntType > - A discrete Poisson random number distribution.

Synopsis

       #include <random>

   Classes
       struct param_typePublicTypestypedef _IntType result_typePublicMemberFunctionspoisson_distribution (const param_type &__p)
       poisson_distribution (double __mean)
       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_typemax () const
           Returns the least upper bound value of the distribution.
       double mean () const
           Returns the distribution parameter mean.
       result_typemin () const
           Returns the greatest lower bound value of the distribution.
       template<typename_UniformRandomNumberGenerator > result_typeoperator() (_UniformRandomNumberGenerator
           &__urng)
           Generating functions.
       template<typename_UniformRandomNumberGenerator > result_typeoperator() (_UniformRandomNumberGenerator
           &__urng, const param_type &__p)
       param_typeparam () const
           Returns the parameter set of the distribution.
       voidparam (const param_type &__param)
           Sets the parameter set of the distribution.
       voidreset ()
           Resets the distribution state.

   Friends
       template<typename_IntType1 , typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits >
           & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const std::poisson_distribution< _IntType1
           > &__x)
           Inserts a poisson_distribution random number distribution __x into the output stream __os.
       bool operator== (const poisson_distribution &__d1, const poisson_distribution &__d2)
           Return true if two Poisson distributions have the same parameters and the sequences that would be
           generated are equal.
       template<typename_IntType1 , typename _CharT , typename _Traits > std::basic_istream< _CharT, _Traits >
           & operator>> (std::basic_istream< _CharT, _Traits > &__is, std::poisson_distribution< _IntType1 >
           &__x)
           Extracts a poisson_distribution random number distribution __x from the input stream __is.

See Also