...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
boost::random::fisher_f_distribution
// In header: <boost/random/fisher_f_distribution.hpp> template<typename RealType = double> class fisher_f_distribution { public: // types typedef RealType result_type; typedef RealType input_type; // member classes/structs/unions class param_type { public: // types typedef fisher_f_distribution distribution_type; // construct/copy/destruct explicit param_type(RealType = 1.0, RealType = 1.0); // public member functions RealType m() const; 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 fisher_f_distribution(RealType = 1.0, RealType = 1.0); explicit fisher_f_distribution(const param_type &); // public member functions template<typename URNG> RealType operator()(URNG &); template<typename URNG> RealType operator()(URNG &, const param_type &) const; RealType m() 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 fisher_f_distribution &); template<typename CharT, typename Traits> friend std::basic_istream< CharT, Traits > & operator>>(std::basic_istream< CharT, Traits > &, const fisher_f_distribution &); friend bool operator==(const fisher_f_distribution &, const fisher_f_distribution &); friend bool operator!=(const fisher_f_distribution &, const fisher_f_distribution &); };
The Fisher F distribution is a real valued distribution with two parameters m and n.
It has .
fisher_f_distribution
public
construct/copy/destructexplicit fisher_f_distribution(RealType m = 1.0, RealType n = 1.0);
Constructs a
from its "m" and "n" parameters.fisher_f_distribution
Requires: m > 0 and n > 0
explicit fisher_f_distribution(const param_type & param);
Constructs an
from its parameters. fisher_f_distribution
fisher_f_distribution
public member functionstemplate<typename URNG> RealType operator()(URNG & urng);
Returns a random variate distributed according to the F distribution.
template<typename URNG> RealType operator()(URNG & urng, const param_type & param) const;
Returns a random variate distributed according to the F distribution with parameters specified by param
.
RealType m() const;
Returns the "m" parameter of the distribution.
RealType n() const;
Returns the "n" parameter of the distribution.
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.
fisher_f_distribution
friend functionstemplate<typename CharT, typename Traits> friend std::basic_ostream< CharT, Traits > & operator<<(std::basic_ostream< CharT, Traits > & os, const fisher_f_distribution & fd);
Writes an
to a fisher_f_distribution
std::ostream
.
template<typename CharT, typename Traits> friend std::basic_istream< CharT, Traits > & operator>>(std::basic_istream< CharT, Traits > & is, const fisher_f_distribution & fd);
Reads an
from a fisher_f_distribution
std::istream
.
friend bool operator==(const fisher_f_distribution & lhs, const fisher_f_distribution & rhs);
Returns true if the two instances of
will return identical sequences of values given equal generators. fisher_f_distribution
friend bool operator!=(const fisher_f_distribution & lhs, const fisher_f_distribution & rhs);
Returns true if the two instances of
will return different sequences of values given equal generators. fisher_f_distribution