bionic (3) std::extreme_value_distribution.3cxx.gz

Provided by: libstdc++-5-doc_5.5.0-12ubuntu1_all bug

NAME

       std::extreme_value_distribution< _RealType >

SYNOPSIS

   Classes
       struct param_type

   Public Types
       typedef _RealType result_type

   Public Member Functions
       extreme_value_distribution (_RealType __a=_RealType(0), _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
       _RealType b () const
       result_type max () const
       result_type min () const
       template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator
           &__urng)
       template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator
           &__urng, const param_type &__p)
       param_type param () const
       void param (const param_type &__param)
       void reset ()

   Friends
       bool operator== (const extreme_value_distribution &__d1, const extreme_value_distribution &__d2)

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})) ]

       Definition at line 4886 of file random.h.

Member Typedef Documentation

   template<typename _RealType = double> typedef _RealType std::extreme_value_distribution< _RealType
       >::result_type
       The type of the range of the distribution.

       Definition at line 4889 of file random.h.

Member Function Documentation

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

       Definition at line 4944 of file random.h.

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

       Definition at line 4951 of file random.h.

   template<typename _RealType = double> result_type std::extreme_value_distribution< _RealType >::max () const
       [inline]
       Returns the least upper bound value of the distribution.

       Definition at line 4980 of file random.h.

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

   template<typename _RealType = double> result_type std::extreme_value_distribution< _RealType >::min () const
       [inline]
       Returns the greatest lower bound value of the distribution.

       Definition at line 4973 of file random.h.

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

   template<typename _RealType = double> template<typename _UniformRandomNumberGenerator > result_type
       std::extreme_value_distribution< _RealType >::operator() (_UniformRandomNumberGenerator & __urng)
       [inline]
       Generating functions.

       Definition at line 4988 of file random.h.

       Referenced by std::operator>>().

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

       Definition at line 4958 of file random.h.

       Referenced by std::operator>>().

   template<typename _RealType = double> void std::extreme_value_distribution< _RealType >::param (const
       param_type & __param) [inline]
       Sets the parameter set of the distribution.

       Parameters:
           __param The new parameter set of the distribution.

       Definition at line 4966 of file random.h.

   template<typename _RealType = double> void std::extreme_value_distribution< _RealType >::reset () [inline]
       Resets the distribution state.

       Definition at line 4937 of file random.h.

   template<typename _RealType = double> bool operator== (const extreme_value_distribution< _RealType > & __d1,
       const extreme_value_distribution< _RealType > & __d2) [friend]
       Return true if two extreme value distributions have the same parameters.

       Definition at line 5023 of file random.h.

Author

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

libstdc++                                        Wed Apr 11 20std::extreme_value_distribution< _RealType >(3cxx)