libstdc++
Classes | Public Types | Public Member Functions | Friends

std::extreme_value_distribution< _RealType > Class Template Reference
Poisson Distributions

A extreme_value_distribution random number distribution. More...

List of all members.

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)
void param (const param_type &__param)
param_type param () const
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 5050 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 5057 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 5108 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 5115 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 5144 of file random.h.

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

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

Generating functions.

Definition at line 5152 of file random.h.

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

Referenced by std::extreme_value_distribution< _RealType >::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 5122 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:
__paramThe new parameter set of the distribution.

Definition at line 5130 of file random.h.

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

Resets the distribution state.

Definition at line 5101 of file random.h.

Friends And Related Function Documentation

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

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