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::binomial_distribution< _IntType > - A discrete binomial random number distribution.

Author

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

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

Detailed Description

template<typename_IntType=int>                                            n
       class std::binomial_distribution< _IntType >"A discrete binomial random nomber distribution.
                                                                                m
       The formula for the binomial probability density function is $p(i|t,p) = {} p^i (1 - p)^{t - i}$ where
       $t$ and $p$ are the parameters of the distribution.                      t
                                                                                }
       Since                                                                    {
           C++11

Member Function Documentation

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

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

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

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

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

   template<typename_IntType>template<typename_UniformRandomNumberGenerator>binomial_distribution<_IntType>::result_typestd::binomial_distribution<_IntType>::operator()(_UniformRandomNumberGenerator&__urng,constparam_type&__param)
       A rejection algorithm when t * p >= 8 and a simple waiting time method - the second in the referenced
       book - 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,
       Sect. 4 (+ Errata!).

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

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

   template<typename_IntType=int>param_typestd::binomial_distribution<_IntType>::param()const[inline]

       Returns the parameter set of the distribution.

   template<typename_IntType=int>voidstd::binomial_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::binomial_distribution<_IntType>::reset()[inline]
       Resets the distribution state.

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

   template<typename_IntType=int>_IntTypestd::binomial_distribution<_IntType>::t()const[inline]
       Returns the distribution t parameter.

Member Typedef Documentation

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

Name

       std::binomial_distribution< _IntType > - A discrete binomial random number distribution.

Synopsis

       #include <random>

   Classes
       struct param_typePublicTypestypedef _IntType result_typePublicMemberFunctionsbinomial_distribution (_IntType __t, double __p=0.5)
       binomial_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)
       result_typemax () const
           Returns the least upper bound value of the distribution.
       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)
       double p () const
           Returns the distribution p parameter.
       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.
       _IntType t () const
           Returns the distribution t parameter.

   Friends
       template<typename_IntType1 , typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits >
           & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const std::binomial_distribution<
           _IntType1 > &__x)
           Inserts a binomial_distribution random number distribution __x into the output stream __os.
       bool operator== (const binomial_distribution &__d1, const binomial_distribution &__d2)
           Return true if two binomial 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::binomial_distribution< _IntType1 >
           &__x)
           Extracts a binomial_distribution random number distribution __x from the input stream __is.

See Also