Classes

struct param_type

Public Types

typedef _RealType result_type

Public Member Functions

fisher_f_distribution (_RealType __m=_RealType(1), _RealType __n=_RealType(1))
fisher_f_distribution (const param_type &__p)
_RealType m () const
result_type max () const
result_type min () const
_RealType n () 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

template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_ostream< _CharT,
_Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &, const std::fisher_f_distribution< _RealType1 > &)
template<typename _RealType1 > bool operator== (const std::fisher_f_distribution< _RealType1 > &__d1, const std::fisher_f_distribution< _RealType1 > &__d2)
template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_istream< _CharT,
_Traits > & operator>> (std::basic_istream< _CharT, _Traits > &, std::fisher_f_distribution< _RealType1 > &)

Detailed Description

A fisher_f_distribution random number distribution.

The formula for the normal probability mass function is

$p(x|m,n) = \frac{\Gamma((m+n)/2)}{\Gamma(m/2)\Gamma(n/2)} (\frac{m}{n})^{m/2} x^{(m/2)-1} (1 + \frac{mx}{n})^{-(m+n)/2}$

Member Typedef Documentation

typedef _RealType std::fisher_f_distribution::result_type

The type of the range of the distribution.

Definition at line 2861 of file random.h.

Member Function Documentation

result_type std::fisher_f_distribution::max ( ) const [inline]

Returns the least upper bound value of the distribution.

Definition at line 2948 of file random.h.

result_type std::fisher_f_distribution::min ( ) const [inline]

Returns the greatest lower bound value of the distribution.

Definition at line 2941 of file random.h.

template<typename _UniformRandomNumberGenerator >

result_type std::fisher_f_distribution::operator() ( _UniformRandomNumberGenerator & __urng ) [inline]

Generating functions.

Definition at line 2956 of file random.h.

param_type std::fisher_f_distribution::param ( ) const [inline]

Returns the parameter set of the distribution.

Definition at line 2926 of file random.h.

void std::fisher_f_distribution::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 2934 of file random.h.

void std::fisher_f_distribution::reset ( ) [inline]

Resets the distribution state.

Definition at line 2905 of file random.h.

References std::gamma_distribution::reset().

Friends And Related Function Documentation

template<typename _RealType1 , typename _CharT , typename _Traits >

std::basic_ostream<_CharT, _Traits>& operator<<	(	std::basic_ostream< _CharT, _Traits > &	,
		const std::fisher_f_distribution< _RealType1 > &
	)		`[friend]`

Inserts a fisher_f_distribution random number distribution __x into the output stream __os.

Parameters:

__os	An output stream.
__x	A fisher_f_distribution random number distribution.

Returns:: The output stream with the state of __x inserted or in an error state.

template<typename _RealType1 >

bool operator==	(	const std::fisher_f_distribution< _RealType1 > &	__d1,
		const std::fisher_f_distribution< _RealType1 > &	__d2
	)		`[friend]`

Return true if two Fisher f distributions have the same parameters and the sequences that would be generated are equal.

Definition at line 2977 of file random.h.

template<typename _RealType1 , typename _CharT , typename _Traits >

std::basic_istream<_CharT, _Traits>& operator>>	(	std::basic_istream< _CharT, _Traits > &	,
		std::fisher_f_distribution< _RealType1 > &
	)		`[friend]`

Extracts a fisher_f_distribution random number distribution __x from the input stream __is.

Parameters:

__is	An input stream.
__x	A fisher_f_distribution random number generator engine.

Returns:: The input stream with __x extracted or in an error state.

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

random.h