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

Author

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

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

Detailed Description

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

       The formula for the normal probability mass function is
           p(x|a,b) = ac{1}{b}
                      \xp( ac{a-x}{b} - \xp(ac{a-x}{b})) ]

       Since
           C++11

Member Function Documentation

template<typename_RealType=double>_RealTypestd::extreme_value_distribution<_RealType>::a()const[inline]
       Return the $a$ parameter of the distribution.

   template<typename_RealType=double>_RealTypestd::extreme_value_distribution<_RealType>::b()const[inline]
       Return the $b$ parameter of the distribution.

   template<typename_RealType=double>result_typestd::extreme_value_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::extreme_value_distribution<_RealType>::min()const[inline]
       Returns the greatest lower bound value of the distribution.

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

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

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

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

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

   template<typename_RealType=double>voidstd::extreme_value_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::extreme_value_distribution<_RealType>::reset()[inline]
       Resets the distribution state.

Member Typedef Documentation

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

Name

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

Synopsis

       #include <random>

   Classes
       struct param_typePublicTypestypedef _RealType result_typePublicMemberFunctionsextreme_value_distribution (_RealType __a, _RealType __b=_RealType(1))
       extreme_value_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 a () const
           Return the $a$ parameter of the distribution.
       _RealType b () const
           Return the $b$ parameter of the 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
       bool operator== (const extreme_value_distribution &__d1, const extreme_value_distribution &__d2)
           Return true if two extreme value distributions have the same parameters.

See Also