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

#include <chi_squared_distribution.hpp>

Public Types
typedef chi_squared_distribution	distribution_type

Public Member Functions
	param_type (RealType n_arg=RealType(1))
	Construct a param_type object. More...
RealType	n () const
	Returns the n parameter of the distribution. More...

Friends
template<class CharT , class Traits >
std::basic_ostream< CharT, Traits > &	operator<< (std::basic_ostream< CharT, Traits > &os, const param_type &parm)
	Writes the parameters of the distribution to a std::ostream. More...
template<class CharT , class Traits >
std::basic_istream< CharT, Traits > &	operator>> (std::basic_istream< CharT, Traits > &is, param_type &parm)
	Reads the parameters of the distribution from a std::istream. More...
bool	operator== (const param_type &lhs, const param_type &rhs)
	Returns true if the parameters have the same values. More...
bool	operator!= (const param_type &lhs, const param_type &rhs)
	Returns true if the parameters have different values. More...

Member Typedef Documentation

template<class RealType = double>

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

Constructor & Destructor Documentation

template<class RealType = double>

boost::random::chi_squared_distribution< RealType >::param_type::param_type ( RealType  n_arg = RealType(1) )

inlineexplicit

Construct a param_type object.

n is the parameter of the distribution.

Requires: t >=0 && 0 <= p <= 1

Member Function Documentation

template<class RealType = double>

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

inline

Returns the n parameter of the distribution.

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

Friends And Related Function Documentation

template<class RealType = double>

bool operator!= ( const param_type &  lhs, const param_type &  rhs  )

friend

Returns true if the parameters have different values.

template<class RealType = double>

template<class CharT , class Traits >

std::basic_ostream<CharT,Traits>& operator<< ( std::basic_ostream< CharT, Traits > &  os, const param_type &  parm  )

friend

Writes the parameters of the distribution to a std::ostream.

template<class RealType = double>

bool operator== ( const param_type &  lhs, const param_type &  rhs  )

friend

Returns true if the parameters have the same values.

template<class RealType = double>

template<class CharT , class Traits >

std::basic_istream<CharT,Traits>& operator>> ( std::basic_istream< CharT, Traits > &  is, param_type &  parm  )

friend

Reads the parameters of the distribution from a std::istream.

---

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

• boost_1_57_0/boost/random/chi_squared_distribution.hpp