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::chi_squared_distribution< _RealType > - A chi_squared_distribution random number distribution.

Author

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

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

Detailed Description

template<typename_RealType=double>
       class std::chi_squared_distribution< _RealType >"A chi_squared_distribution random number distribution.

       The formula for the normal probability mass function is $p(x|n) = ac{x^{(n/2) - 1}e^{-x/2}}{Gamma(n/2)
       2^{n/2}}$

       Since
           C++11

Member Function Documentation

template<typename_RealType=double>result_typestd::chi_squared_distribution<_RealType>::max()const[inline]
       Returns the least upper bound value of the distribution.

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

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

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

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

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

       Parameters__param The new parameter set of the distribution.

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

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

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

Member Typedef Documentation

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

Name

       std::chi_squared_distribution< _RealType > - A chi_squared_distribution random number distribution.

Synopsis

       #include <random>

   Classes
       struct param_typePublicTypestypedef _RealType result_typePublicMemberFunctionschi_squared_distribution (_RealType __n)
       chi_squared_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)
       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.
       _RealType n () const
       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::chi_squared_distribution<
           _RealType1 > &__x)
           Inserts a chi_squared_distribution random number distribution __x into the output stream __os.
       bool operator== (const chi_squared_distribution &__d1, const chi_squared_distribution &__d2)
           Return true if two Chi-squared 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::chi_squared_distribution< _RealType1
           > &__x)
           Extracts a chi_squared_distribution random number distribution __x from the input stream __is.

See Also