Provided by: libstdc++6-4.6-doc_4.6.3-1ubuntu5_all bug

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 > &, const
           std::student_t_distribution< _RealType1 > &)"
       template<typename _RealType1 > bool operator== (const std::student_t_distribution<
           _RealType1 > &__d1, const std::student_t_distribution< _RealType1 > &__d2)
       template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_istream<
           _CharT,
           _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &,
           std::student_t_distribution< _RealType1 > &)"

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}{t(ni)}
       ac{Gamma((n+1)/2)}{Gamma(n/2)} (1 + ac{x^2}{n}) ^{-(n+1)/2} ]

       Definition at line 3043 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 3126 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 3119 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 3134 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 3104 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 3112 of file random.h.

   template<typename _RealType = double> void std::student_t_distribution< _RealType >::reset ()
       [inline]
       Resets the distribution state.

       Definition at line 3087 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 > &, const std::student_t_distribution< _RealType1 > &) [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> 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 3156 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 > &, std::student_t_distribution< _RealType1 > &) [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.

libstdc++                                Sun Apr 15std::student_t_distribution< _RealType >(3cxx)