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::gamma_distribution< _RealType > - A gamma continuous distribution for random numbers.

Author

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

                                                    libstdc++         std::gamma_distribution<_RealType>(3cxx)

Constructor & Destructor Documentation

template<typename_RealType=double>std::gamma_distribution<_RealType>::gamma_distribution()[inline]
       Constructs a gamma distribution with parameters 1 and 1.

   template<typename_RealType=double>std::gamma_distribution<_RealType>::gamma_distribution(_RealType__alpha_val,_RealType__beta_val=_RealType(1))[inline], a[explicit]
       Constructs a gamma distribution with parameters $lpha$ and $$
                                                                   .

Member Function Documentation

template<typename_RealType=double>_RealTypestd::gamma_distribution<_RealType>::alpha()const[inline]
       Returns the $lpha$ of the distribution.
                    t
   template<typenamea_RealType=double>_RealTypestd::gamma_distribution<_RealType>::beta()const[inline]
                    $
       Returns the $o distribution.
                    f
   template<typenamet_RealType=double>result_typestd::gamma_distribution<_RealType>::max()const[inline]     h
       Returns the least upper bound value of the distribution.

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

   template<typename_RealType=double>result_typestd::gamma_distribution<_RealType>::min()const[inline]
       Returns the greatest lower bound value of the distribution.

   template<typename_RealType=double>template<typename_UniformRandomNumberGenerator>result_typestd::gamma_distribution<_RealType>::operator()(_UniformRandomNumberGenerator&__urng)[inline]
       Generating functions.

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

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

   template<typename_RealType>template<typename_UniformRandomNumberGenerator>gamma_distribution<_RealType>::result_typestd::gamma_distribution<_RealType>::operator()(_UniformRandomNumberGenerator&__urng,constparam_type&__param)
       Marsaglia, G. and Tsang, W. W. 'A Simple Method for Generating Gamma Variables' ACM Transactions on
       Mathematical Software, 26, 3, 363-372, 2000.

       References std::log(), and std::pow().

   template<typename_RealType=double>param_typestd::gamma_distribution<_RealType>::param()const[inline]
       Returns the parameter set of the distribution.

       Referenced by std::chi_squared_distribution<_RealType>::param().

   template<typename_RealType=double>voidstd::gamma_distribution<_RealType>::param(constparam_type&__param)[inline]
       Sets the parameter set of the distribution.

       Parameters__param The new parameter set of the distribution.

   template<typename_RealType=double>voidstd::gamma_distribution<_RealType>::reset()[inline]
       Resets the distribution state.

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

       Referenced by std::chi_squared_distribution<_RealType>::reset(), std::fisher_f_distribution<_RealType>::reset(), std::student_t_distribution<_RealType>::reset(), and std::negative_binomial_distribution<_IntType>::reset().

Member Typedef Documentation

template<typename_RealType=double>typedef_RealTypestd::gamma_distribution<_RealType>::result_type
       The type of the range of the distribution.

Name

       std::gamma_distribution< _RealType > - A gamma continuous distribution for random numbers.

Synopsis

       #include <random>

   Classes
       struct param_typePublicTypestypedef _RealType result_typePublicMemberFunctionsgamma_distribution ()
           Constructs a gamma distribution with parameters 1 and 1.     t
       gamma_distribution (_RealType __alpha_val, _RealType __beta_val=_aealType(1))
           Constructs a gamma distribution with parameters $.lpha$ and $$
       gamma_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 alpha (t const
           Returns the $a.lpha$ of the distribution.
       _RealType beta ()$const
           Returns the $o distribution.
       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)
       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_RealType1 , typename _CharT , typename _Traits > std::basic_ostream< _CharT, _Traits >
           & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const std::gamma_distribution< _RealType1
           > &__x)
           Inserts a gamma_distribution random number distribution __x into the output stream __os.
       bool operator== (const gamma_distribution &__d1, const gamma_distribution &__d2)
           Return true if two gamma distributions have the same parameters and the sequences that would be
           generated are equal.
       template<typename_RealType1 , typename _CharT , typename _Traits > std::basic_istream< _CharT, _Traits >
           & operator>> (std::basic_istream< _CharT, _Traits > &__is, std::gamma_distribution< _RealType1 >
           &__x)
           Extracts a gamma_distribution random number distribution __x from the input stream __is.

DetailedDescriptiont             t
   template<typenamea_RealType=double>
       class std::ga)ma_distributi)n< _RealType >"A gamma continuous distribution for random numbers.
                    =             ^
       The formula far the gamma p{obability density function is:
           p(x|lpha,c             l     t
                    {          (x/p^{-x/a ]
                    1             h     }
                    }             a
                    {             -
                                  1
                                  }

       Since
           C++11

See Also