|  | Home | Libraries | People | FAQ | More | 
boost::random::student_t_distribution
// In header: <boost/random/student_t_distribution.hpp> template<typename RealType = double> class student_t_distribution { public: // types typedef RealType result_type; typedef RealType input_type; // member classes/structs/unions class param_type { public: // types typedef student_t_distribution distribution_type; // construct/copy/destruct explicit param_type(RealType = 1.0); // public member functions RealType n() const; // friend functions template<typename CharT, typename Traits> friend std::basic_ostream< CharT, Traits > & operator<<(std::basic_ostream< CharT, Traits > &, const param_type &); template<typename CharT, typename Traits> friend std::basic_istream< CharT, Traits > & operator>>(std::basic_istream< CharT, Traits > &, const param_type &); friend bool operator==(const param_type &, const param_type &); friend bool operator!=(const param_type &, const param_type &); }; // construct/copy/destruct explicit student_t_distribution(RealType = 1.0); explicit student_t_distribution(const param_type &); // public member functions template<typename URNG> RealType operator()(URNG &); template<typename URNG> RealType operator()(URNG &, const param_type &) const; RealType n() const; RealType min() const; RealType max() const; param_type param() const; void param(const param_type &); void reset(); // friend functions template<typename CharT, typename Traits> friend std::basic_ostream< CharT, Traits > & operator<<(std::basic_ostream< CharT, Traits > &, const student_t_distribution &); template<typename CharT, typename Traits> friend std::basic_istream< CharT, Traits > & operator>>(std::basic_istream< CharT, Traits > &, const student_t_distribution &); friend bool operator==(const student_t_distribution &, const student_t_distribution &); friend bool operator!=(const student_t_distribution &, const student_t_distribution &); };
The Student t distribution is a real valued distribution with one parameter n, the number of degrees of freedom.
It has  .
. 
student_t_distribution 
        public
       construct/copy/destructexplicit student_t_distribution(RealType n = 1.0);
Constructs an student_t_distribution
Requires: n > 0
explicit student_t_distribution(const param_type & param);
Constructs an student_t_distribution
student_t_distribution public member functionstemplate<typename URNG> RealType operator()(URNG & urng);
Returns a random variate distributed according to the Student t distribution.
template<typename URNG> RealType operator()(URNG & urng, const param_type & param) const;
Returns a random variate distributed accordint to the Student t distribution with parameters specified by param. 
RealType n() const;
Returns the number of degrees of freedom.
RealType min() const;
Returns the smallest value that the distribution can produce.
RealType max() const;
Returns the largest value that the distribution can produce.
param_type param() const;
Returns the parameters of the distribution.
void param(const param_type & param);
Sets the parameters of the distribution.
void reset();
Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.
student_t_distribution friend functionstemplate<typename CharT, typename Traits> friend std::basic_ostream< CharT, Traits > & operator<<(std::basic_ostream< CharT, Traits > & os, const student_t_distribution & td);
Writes a student_t_distributionstd::ostream. 
template<typename CharT, typename Traits> friend std::basic_istream< CharT, Traits > & operator>>(std::basic_istream< CharT, Traits > & is, const student_t_distribution & td);
Reads a student_t_distributionstd::istream. 
friend bool operator==(const student_t_distribution & lhs, const student_t_distribution & rhs);
Returns true if the two instances of student_t_distribution
friend bool operator!=(const student_t_distribution & lhs, const student_t_distribution & rhs);
Returns true if the two instances of student_t_distribution