Scroll to navigation

std::student_t_distribution< _RealType >(3cxx) std::student_t_distribution< _RealType >(3cxx)

NAME

std::student_t_distribution< _RealType > -

SYNOPSIS

Classes


struct param_type
 

Public Types


typedef _RealType result_type
 

Public Member Functions


student_t_distribution (_RealType __n=_RealType(1))
 
student_t_distribution (const param_type &__p)
 
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 > &__os, const std::student_t_distribution< _RealType1 > &__x)"
 
bool operator== (const student_t_distribution &__d1, const student_t_distribution &__d2)
 
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)"
 

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:
Definition at line 3047 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 3050 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 3130 of file random.h.
References std::numeric_limits< _Tp >::max().

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 3123 of file random.h.
References std::numeric_limits< _Tp >::min().

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

Generating functions.
Definition at line 3138 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 3108 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:
__param The new parameter set of the distribution.
 
Definition at line 3116 of file random.h.

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

Resets the distribution state.
Definition at line 3091 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:
__os An output stream.
 
__x A 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> bool operator== (const student_t_distribution< _RealType > &__d1, const student_t_distribution< _RealType > &__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 3159 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:
__is An input stream.
 
__x A student_t_distribution random number generator engine.
Returns:
The input stream with __x extracted or in an error state.
 
 

Author

Generated automatically by Doxygen for libstdc++ from the source code.
Sun Jan 6 2013 libstdc++