![]() |
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 ; typedef RealType ; // member classes/structs/unions class param_type { public: // types typedef student_t_distribution ; // construct/copy/destruct (RealType = ); // public member functions RealType () ; // friend functions template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const param_type &); template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const param_type &); bool (const param_type &, const param_type &); bool (const param_type &, const param_type &); }; // construct/copy/destruct (RealType = ); (const param_type &); // public member functions template<typename URNG> RealType (URNG &); template<typename URNG> RealType (URNG &, const param_type &) ; RealType () ; RealType () ; RealType () ; param_type () ; void (const param_type &); void (); // friend functions template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const student_t_distribution &); template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const student_t_distribution &); bool (const student_t_distribution &, const student_t_distribution &); bool (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/destruct(RealType n = );
Constructs an
with "n" degrees of freedom.student_t_distribution
Requires: n > 0
(const param_type & param);
Constructs an
from its parameters. student_t_distribution
student_t_distribution
public member functionstemplate<typename URNG> RealType (URNG & urng);
Returns a random variate distributed according to the Student t distribution.
template<typename URNG> RealType (URNG & urng, const param_type & param) ;
Returns a random variate distributed accordint to the Student t distribution with parameters specified by param
.
RealType () ;
Returns the number of degrees of freedom.
RealType () ;
Returns the smallest value that the distribution can produce.
RealType () ;
Returns the largest value that the distribution can produce.
param_type () ;
Returns the parameters of the distribution.
void (const param_type & param);
Sets the parameters of the distribution.
void ();
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> CharT, Traits > & (CharT, Traits > & os, const student_t_distribution & td);
Writes a
to a student_t_distribution
std::ostream
.
template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > & is, const student_t_distribution & td);
Reads a
from a student_t_distribution
std::istream
.
bool (const student_t_distribution & lhs, const student_t_distribution & rhs);
Returns true if the two instances of
will return identical sequences of values given equal generators. student_t_distribution
bool (const student_t_distribution & lhs, const student_t_distribution & rhs);
Returns true if the two instances of
will return different sequences of values given equal generators. student_t_distribution