| std::student_t_distribution< _RealType >(3cxx) | std::student_t_distribution< _RealType >(3cxx) | 
NAME¶
std::student_t_distribution< _RealType > - A student_t_distribution random number distribution.
SYNOPSIS¶
#include <random>
Classes¶
struct param_type
  
  
Public Types¶
typedef _RealType result_type
  
  
Public Member Functions¶
student_t_distribution (_RealType __n)
  
  student_t_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)
  
  template<typename _UniformRandomNumberGenerator >
    void __generate (result_type *__f, result_type
    *__t, _UniformRandomNumberGenerator &__urng, const
    param_type &__p)
  
  result_type max () const
  
  Returns the least upper bound value of the distribution. result_type
    min () const
  
  Returns the greatest lower bound value of the distribution. _RealType n
    () const
  
  template<typename _UniformRandomNumberGenerator >
    result_type operator() (_UniformRandomNumberGenerator
    &__urng)
  
  Generating functions. template<typename
    _UniformRandomNumberGenerator > result_type
    operator() (_UniformRandomNumberGenerator &__urng,
    const param_type &__p)
  
  param_type param () const
  
  Returns the parameter set of the distribution. void param (const
    param_type &__param)
  
  Sets the parameter set of the distribution. void reset ()
  
  Resets the distribution state.
  
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)
  
  Inserts a student_t_distribution random number distribution __x into the
    output stream __os. bool operator== (const
    student_t_distribution &__d1, const
    student_t_distribution &__d2)
  
  Return true if two Student t distributions have the same parameters and the
    sequences that would be generated are equal. 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)
  
  Extracts a student_t_distribution random number distribution __x from the
    input stream __is.
  
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) = ac{1}{rt(ni)}
  
ac{Gamma((n+1)/2)}{Gamma(n/2)}
  
   (1 + ac{x^2}{n}) ^{-(n+1)/2} ]
Since
Member Typedef Documentation¶
template<typename _RealType = double> typedef _RealType std::student_t_distribution< _RealType >::result_type¶
The type of the range of the distribution.
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.
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.
References std::numeric_limits< _Tp >::lowest().
template<typename _RealType = double> template<typename _UniformRandomNumberGenerator > result_type std::student_t_distribution< _RealType >::operator() (_UniformRandomNumberGenerator & __urng) [inline]¶
Generating functions.
References std::sqrt().
template<typename _RealType = double> param_type std::student_t_distribution< _RealType >::param () const [inline]¶
Returns the parameter set of the distribution.
template<typename _RealType = double> void std::student_t_distribution< _RealType >::param (const param_type & __param) [inline]¶
Sets the parameter set of the distribution.
Parameters
template<typename _RealType = double> void std::student_t_distribution< _RealType >::reset () [inline]¶
Resets the distribution state.
References std::normal_distribution< _RealType >::reset(), and std::gamma_distribution< _RealType >::reset().
Friends And Related Symbol 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
__x A student_t_distribution random number distribution.
Returns
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.
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
__x A student_t_distribution random number generator engine.
Returns
Author¶
Generated automatically by Doxygen for libstdc++ from the source code.
| libstdc++ |