boost::random::fisher_f_distribution< RealType >::param_type Class Reference

#include <fisher_f_distribution.hpp>

Public Types
typedef fisher_f_distribution	distribution_type

Public Member Functions
	param_type (RealType m_arg=RealType(1.0), RealType n_arg=RealType(1.0))
	Constructs a param_type from the "m" and "n" parameters of the distribution. More...
RealType	m () const
	Returns the "m" parameter of the distribtuion. More...
RealType	n () const
	Returns the "n" parameter of the distribution. More...
	BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR (os, param_type, parm)
	Writes a param_type to a std::ostream. More...
	BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR (is, param_type, parm)
	Reads a param_type from a std::istream. More...
	BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR (param_type, lhs, rhs)
	Returns true if the two sets of parameters are the same. More...

Member Typedef Documentation

template<class RealType = double>

typedef fisher_f_distribution boost::random::fisher_f_distribution< RealType >::param_type::distribution_type

Constructor & Destructor Documentation

template<class RealType = double>

boost::random::fisher_f_distribution< RealType >::param_type::param_type ( RealType  m_arg = RealType(1.0), RealType  n_arg = RealType(1.0)  )

inlineexplicit

Constructs a param_type from the "m" and "n" parameters of the distribution.

Requires: m > 0 and n > 0

Referenced by boost::random::fisher_f_distribution< RealType >::param().

Member Function Documentation

template<class RealType = double>

boost::random::fisher_f_distribution< RealType >::param_type::BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR ( param_type  , lhs  , rhs    )

inline

Returns true if the two sets of parameters are the same.

template<class RealType = double>

boost::random::fisher_f_distribution< RealType >::param_type::BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR ( is  , param_type  , parm    )

inline

Reads a param_type from a std::istream.

template<class RealType = double>

boost::random::fisher_f_distribution< RealType >::param_type::BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR ( os  , param_type  , parm    )

inline

Writes a param_type to a std::ostream.

template<class RealType = double>

RealType boost::random::fisher_f_distribution< RealType >::param_type::m ( ) const

inline

Returns the "m" parameter of the distribtuion.

Referenced by boost::random::fisher_f_distribution< RealType >::operator()(), and boost::random::fisher_f_distribution< RealType >::param().

template<class RealType = double>

RealType boost::random::fisher_f_distribution< RealType >::param_type::n ( ) const

inline

Returns the "n" parameter of the distribution.

Referenced by boost::random::fisher_f_distribution< RealType >::operator()(), and boost::random::fisher_f_distribution< RealType >::param().

---

The documentation for this class was generated from the following file:

• boost_1_57_0/boost/random/fisher_f_distribution.hpp