The Fisher F distribution is a real valued distribution with two parameters m and n. More...
#include <fisher_f_distribution.hpp>
Classes | |
class | param_type |
Public Types | |
typedef RealType | result_type |
typedef RealType | input_type |
Public Member Functions | |
fisher_f_distribution (RealType m_arg=RealType(1.0), RealType n_arg=RealType(1.0)) | |
Constructs a fisher_f_distribution from its "m" and "n" parameters. More... | |
fisher_f_distribution (const param_type &parm) | |
Constructs an fisher_f_distribution from its parameters. More... | |
template<class URNG > | |
RealType | operator() (URNG &urng) |
Returns a random variate distributed according to the F distribution. More... | |
template<class URNG > | |
RealType | operator() (URNG &urng, const param_type &parm) const |
Returns a random variate distributed according to the F distribution with parameters specified by param . More... | |
RealType | m () const |
Returns the "m" parameter of the distribution. More... | |
RealType | n () const |
Returns the "n" parameter of the distribution. More... | |
RealType min | BOOST_PREVENT_MACRO_SUBSTITUTION () const |
Returns the smallest value that the distribution can produce. More... | |
RealType max | BOOST_PREVENT_MACRO_SUBSTITUTION () const |
Returns the largest value that the distribution can produce. More... | |
param_type | param () const |
Returns the parameters of the distribution. More... | |
void | param (const param_type &parm) |
Sets the parameters of the distribution. More... | |
void | reset () |
Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. More... | |
BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR (os, fisher_f_distribution, fd) | |
Writes an fisher_f_distribution to a std::ostream . More... | |
BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR (is, fisher_f_distribution, fd) | |
Reads an fisher_f_distribution from a std::istream . More... | |
BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR (fisher_f_distribution, lhs, rhs) | |
Returns true if the two instances of fisher_f_distribution will return identical sequences of values given equal generators. More... | |
The Fisher F distribution is a real valued distribution with two parameters m and n.
It has .
typedef RealType boost::random::fisher_f_distribution< RealType >::input_type |
typedef RealType boost::random::fisher_f_distribution< RealType >::result_type |
|
inlineexplicit |
Constructs a fisher_f_distribution
from its "m" and "n" parameters.
Requires: m > 0 and n > 0
Referenced by boost::random::fisher_f_distribution< RealType >::operator()().
|
inlineexplicit |
Constructs an fisher_f_distribution
from its parameters.
|
inline |
Returns the smallest value that the distribution can produce.
|
inline |
Returns the largest value that the distribution can produce.
|
inline |
Returns true if the two instances of fisher_f_distribution
will return identical sequences of values given equal generators.
|
inline |
Reads an fisher_f_distribution
from a std::istream
.
|
inline |
Writes an fisher_f_distribution
to a std::ostream
.
|
inline |
Returns the "m" parameter of the distribution.
|
inline |
Returns the "n" parameter of the distribution.
|
inline |
Returns a random variate distributed according to the F distribution.
References boost::random::fisher_f_distribution< RealType >::param_type::m(), and boost::random::fisher_f_distribution< RealType >::param_type::n().
|
inline |
Returns a random variate distributed according to the F distribution with parameters specified by param
.
References boost::random::fisher_f_distribution< RealType >::fisher_f_distribution().
|
inline |
Returns the parameters of the distribution.
References boost::random::fisher_f_distribution< RealType >::param_type::m(), boost::random::fisher_f_distribution< RealType >::param_type::n(), and boost::random::fisher_f_distribution< RealType >::param_type::param_type().
|
inline |
Sets the parameters of the distribution.
References boost::random::fisher_f_distribution< RealType >::param_type::m(), boost::random::fisher_f_distribution< RealType >::param_type::n(), and boost::random::chi_squared_distribution< RealType >::param().
|
inline |
Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.