libstdc++
std::extreme_value_distribution< _RealType > Class Template Reference

Classes

struct  param_type
 

Public Types

typedef _RealType result_type
 

Public Member Functions

 extreme_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
 
_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) = \frac{1}{b} \exp( \frac{a-x}{b} - \exp(\frac{a-x}{b})) \]

Definition at line 5072 of file random.h.

Member Typedef Documentation

◆ result_type

template<typename _RealType = double>
typedef _RealType std::extreme_value_distribution< _RealType >::result_type

The type of the range of the distribution.

Definition at line 5079 of file random.h.

Member Function Documentation

◆ a()

template<typename _RealType = double>
_RealType std::extreme_value_distribution< _RealType >::a ( ) const
inline

Return the $a$ parameter of the distribution.

Definition at line 5137 of file random.h.

◆ b()

template<typename _RealType = double>
_RealType std::extreme_value_distribution< _RealType >::b ( ) const
inline

Return the $b$ parameter of the distribution.

Definition at line 5144 of file random.h.

◆ max()

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 5173 of file random.h.

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

◆ min()

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 5166 of file random.h.

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

◆ operator()()

template<typename _RealType = double>
template<typename _UniformRandomNumberGenerator >
result_type std::extreme_value_distribution< _RealType >::operator() ( _UniformRandomNumberGenerator &  __urng)
inline

Generating functions.

Definition at line 5181 of file random.h.

◆ param() [1/2]

template<typename _RealType = double>
param_type std::extreme_value_distribution< _RealType >::param ( ) const
inline

Returns the parameter set of the distribution.

Definition at line 5151 of file random.h.

Referenced by std::operator>>().

◆ param() [2/2]

template<typename _RealType = double>
void std::extreme_value_distribution< _RealType >::param ( const param_type __param)
inline

Sets the parameter set of the distribution.

Parameters
__paramThe new parameter set of the distribution.

Definition at line 5159 of file random.h.

◆ reset()

template<typename _RealType = double>
void std::extreme_value_distribution< _RealType >::reset ( )
inline

Resets the distribution state.

Definition at line 5130 of file random.h.

Friends And Related Function Documentation

◆ operator==

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 5216 of file random.h.


The documentation for this class was generated from the following files: