.TH "std::student_t_distribution< _RealType >" 3cxx "Wed Jul 28 2021" "libstdc++" \" -*- nroff -*- .ad l .nh .SH NAME std::student_t_distribution< _RealType > \- A student_t_distribution random number distribution\&. .SH SYNOPSIS .br .PP .SS "Classes" .in +1c .ti -1c .RI "struct \fBparam_type\fP" .br .in -1c .SS "Public Types" .in +1c .ti -1c .RI "typedef _RealType \fBresult_type\fP" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBstudent_t_distribution\fP (_RealType __n)" .br .ti -1c .RI "\fBstudent_t_distribution\fP (const \fBparam_type\fP &__p)" .br .ti -1c .RI "template void \fB__generate\fP (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)" .br .ti -1c .RI "template void \fB__generate\fP (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const \fBparam_type\fP &__p)" .br .ti -1c .RI "template void \fB__generate\fP (\fBresult_type\fP *__f, \fBresult_type\fP *__t, _UniformRandomNumberGenerator &__urng)" .br .ti -1c .RI "template void \fB__generate\fP (\fBresult_type\fP *__f, \fBresult_type\fP *__t, _UniformRandomNumberGenerator &__urng, const \fBparam_type\fP &__p)" .br .ti -1c .RI "\fBresult_type\fP \fBmax\fP () const" .br .RI "Returns the least upper bound value of the distribution\&. " .ti -1c .RI "\fBresult_type\fP \fBmin\fP () const" .br .RI "Returns the greatest lower bound value of the distribution\&. " .ti -1c .RI "_RealType \fBn\fP () const" .br .ti -1c .RI "template \fBresult_type\fP \fBoperator()\fP (_UniformRandomNumberGenerator &__urng)" .br .RI "Generating functions\&. " .ti -1c .RI "template \fBresult_type\fP \fBoperator()\fP (_UniformRandomNumberGenerator &__urng, const \fBparam_type\fP &__p)" .br .ti -1c .RI "\fBparam_type\fP \fBparam\fP () const" .br .RI "Returns the parameter set of the distribution\&. " .ti -1c .RI "void \fBparam\fP (const \fBparam_type\fP &__param)" .br .RI "Sets the parameter set of the distribution\&. " .ti -1c .RI "void \fBreset\fP ()" .br .RI "Resets the distribution state\&. " .in -1c .SS "Friends" .in +1c .ti -1c .RI "template \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator<<\fP (\fBstd::basic_ostream\fP< _CharT, _Traits > &__os, const \fBstd::student_t_distribution\fP< _RealType1 > &__x)" .br .RI "Inserts a student_t_distribution random number distribution \fC__x\fP into the output stream \fC__os\fP\&. " .ti -1c .RI "bool \fBoperator==\fP (const \fBstudent_t_distribution\fP &__d1, const \fBstudent_t_distribution\fP &__d2)" .br .RI "Return true if two Student t distributions have the same parameters and the sequences that would be generated are equal\&. " .ti -1c .RI "template \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator>>\fP (\fBstd::basic_istream\fP< _CharT, _Traits > &__is, \fBstd::student_t_distribution\fP< _RealType1 > &__x)" .br .RI "Extracts a student_t_distribution random number distribution \fC__x\fP from the input stream \fC__is\fP\&. " .in -1c .SH "Detailed Description" .PP .SS "template .br 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) = \frac{1}{\sqrt(n\pi)} \frac{\Gamma((n+1)/2)}{\Gamma(n/2)} (1 + \frac{x^2}{n}) ^{-(n+1)/2} \] .PP Definition at line 3296 of file random\&.h\&. .SH "Member Typedef Documentation" .PP .SS "template typedef _RealType \fBstd::student_t_distribution\fP< _RealType >::\fBresult_type\fP" The type of the range of the distribution\&. .PP Definition at line 3303 of file random\&.h\&. .SH "Member Function Documentation" .PP .SS "template \fBresult_type\fP \fBstd::student_t_distribution\fP< _RealType >::max () const\fC [inline]\fP" .PP Returns the least upper bound value of the distribution\&. .PP Definition at line 3388 of file random\&.h\&. .PP References std::numeric_limits< _Tp >::max()\&. .SS "template \fBresult_type\fP \fBstd::student_t_distribution\fP< _RealType >::min () const\fC [inline]\fP" .PP Returns the greatest lower bound value of the distribution\&. .PP Definition at line 3381 of file random\&.h\&. .PP References std::numeric_limits< _Tp >::lowest()\&. .SS "template template \fBresult_type\fP \fBstd::student_t_distribution\fP< _RealType >::operator() (_UniformRandomNumberGenerator & __urng)\fC [inline]\fP" .PP Generating functions\&. .PP Definition at line 3396 of file random\&.h\&. .PP References std::sqrt()\&. .SS "template \fBparam_type\fP \fBstd::student_t_distribution\fP< _RealType >::param () const\fC [inline]\fP" .PP Returns the parameter set of the distribution\&. .PP Definition at line 3366 of file random\&.h\&. .SS "template void \fBstd::student_t_distribution\fP< _RealType >::param (const \fBparam_type\fP & __param)\fC [inline]\fP" .PP Sets the parameter set of the distribution\&. .PP \fBParameters\fP .RS 4 \fI__param\fP The new parameter set of the distribution\&. .RE .PP .PP Definition at line 3374 of file random\&.h\&. .SS "template void \fBstd::student_t_distribution\fP< _RealType >::reset ()\fC [inline]\fP" .PP Resets the distribution state\&. .PP Definition at line 3349 of file random\&.h\&. .PP References std::normal_distribution< _RealType >::reset(), and std::gamma_distribution< _RealType >::reset()\&. .SH "Friends And Related Function Documentation" .PP .SS "template template \fBstd::basic_ostream\fP<_CharT, _Traits>& operator<< (\fBstd::basic_ostream\fP< _CharT, _Traits > & __os, const \fBstd::student_t_distribution\fP< _RealType1 > & __x)\fC [friend]\fP" .PP Inserts a student_t_distribution random number distribution \fC__x\fP into the output stream \fC__os\fP\&. .PP \fBParameters\fP .RS 4 \fI__os\fP An output stream\&. .br \fI__x\fP A student_t_distribution random number distribution\&. .RE .PP \fBReturns\fP .RS 4 The output stream with the state of \fC__x\fP inserted or in an error state\&. .RE .PP .SS "template bool operator== (const \fBstudent_t_distribution\fP< _RealType > & __d1, const \fBstudent_t_distribution\fP< _RealType > & __d2)\fC [friend]\fP" .PP Return true if two Student t distributions have the same parameters and the sequences that would be generated are equal\&. .PP Definition at line 3445 of file random\&.h\&. .SS "template template \fBstd::basic_istream\fP<_CharT, _Traits>& operator>> (\fBstd::basic_istream\fP< _CharT, _Traits > & __is, \fBstd::student_t_distribution\fP< _RealType1 > & __x)\fC [friend]\fP" .PP Extracts a student_t_distribution random number distribution \fC__x\fP from the input stream \fC__is\fP\&. .PP \fBParameters\fP .RS 4 \fI__is\fP An input stream\&. .br \fI__x\fP A student_t_distribution random number generator engine\&. .RE .PP \fBReturns\fP .RS 4 The input stream with \fC__x\fP extracted or in an error state\&. .RE .PP .SH "Author" .PP Generated automatically by Doxygen for libstdc++ from the source code\&.