libstdc++
Classes | Public Types | Public Member Functions | Friends
std::student_t_distribution< _RealType > Class Template Reference
Normal Distributions

List of all members.

Classes

Public Types

Public Member Functions

Friends

Detailed Description

template<typename _RealType = double>
class std::student_t_distribution< _RealType >

A student_t_distribution random number distribution.

The formula for the normal probability mass function is:

\[ p(x|n) = \frac{1}{\sqrt(n\pi)} \frac{\Gamma((n+1)/2)}{\Gamma(n/2)} (1 + \frac{x^2}{n}) ^{-(n+1)/2} \]

Definition at line 3051 of file random.h.

Member Typedef Documentation

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

The type of the range of the distribution.

Definition at line 3058 of file random.h.

Member Function Documentation

template<typename _RealType = double>
result_type std::student_t_distribution< _RealType >::max ( ) const [inline]

Returns the least upper bound value of the distribution.

Definition at line 3134 of file random.h.

template<typename _RealType = double>
result_type std::student_t_distribution< _RealType >::min ( ) const [inline]

Returns the greatest lower bound value of the distribution.

Definition at line 3127 of file random.h.

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

Generating functions.

Definition at line 3142 of file random.h.

References std::sqrt().

template<typename _RealType = double>
param_type std::student_t_distribution< _RealType >::param ( ) const [inline]

Returns the parameter set of the distribution.

Definition at line 3112 of file random.h.

template<typename _RealType = double>
void std::student_t_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 3120 of file random.h.

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

Resets the distribution state.

Definition at line 3095 of file random.h.

References std::normal_distribution< _RealType >::reset(), and std::gamma_distribution< _RealType >::reset().

Friends And Related Function Documentation

template<typename _RealType = double>
template<typename _RealType1 , typename _CharT , typename _Traits >
std::basic_ostream<_CharT, _Traits>& operator<< ( std::basic_ostream< _CharT, _Traits > &  __os,
const std::student_t_distribution< _RealType1 > &  __x 
) [friend]

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

Parameters:
__osAn output stream.
__xA student_t_distribution random number distribution.
Returns:
The output stream with the state of __x inserted or in an error state.
template<typename _RealType = double>
template<typename _RealType1 >
bool operator== ( const std::student_t_distribution< _RealType1 > &  __d1,
const std::student_t_distribution< _RealType1 > &  __d2 
) [friend]

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

Definition at line 3164 of file random.h.

template<typename _RealType = double>
template<typename _RealType1 , typename _CharT , typename _Traits >
std::basic_istream<_CharT, _Traits>& operator>> ( std::basic_istream< _CharT, _Traits > &  __is,
std::student_t_distribution< _RealType1 > &  __x 
) [friend]

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

Parameters:
__isAn input stream.
__xA student_t_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: