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

#include <cauchy_distribution.hpp>

Public Types
typedef cauchy_distribution	distribution_type

Public Member Functions
	param_type (RealType median_arg=RealType(0.0), RealType sigma_arg=RealType(1.0))
	Constructs the parameters of the cauchy distribution. More...
RealType	median () const
	Returns the median of the distribution. More...
RealType	sigma () const
	Returns the sigma parameter of the distribution. More...
RealType	a () const
	Returns the median of the distribution. More...
RealType	b () const
	Returns the sigma parameter of the distribution. More...
	BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR (os, param_type, parm)
	Writes the parameters to a std::ostream. More...
	BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR (is, param_type, parm)
	Reads the parameters from a std::istream. More...
	BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR (param_type, lhs, rhs)
	Returns true if the two sets of parameters are equal. More...

Member Typedef Documentation

template<class RealType = double>

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

Constructor & Destructor Documentation

template<class RealType = double>

boost::random::cauchy_distribution< RealType >::param_type::param_type ( RealType  median_arg = RealType(0.0), RealType  sigma_arg = RealType(1.0)  )

inlineexplicit

Constructs the parameters of the cauchy distribution.

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

Member Function Documentation

template<class RealType = double>

RealType boost::random::cauchy_distribution< RealType >::param_type::a ( ) const

inline

Returns the median of the distribution.

template<class RealType = double>

RealType boost::random::cauchy_distribution< RealType >::param_type::b ( ) const

inline

Returns the sigma parameter of the distribution.

template<class RealType = double>

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

inline

Returns true if the two sets of parameters are equal.

template<class RealType = double>

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

inline

Reads the parameters from a std::istream.

template<class RealType = double>

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

inline

Writes the parameters to a std::ostream.

template<class RealType = double>

RealType boost::random::cauchy_distribution< RealType >::param_type::median ( ) const

inline

Returns the median of the distribution.

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

template<class RealType = double>

RealType boost::random::cauchy_distribution< RealType >::param_type::sigma ( ) const

inline

Returns the sigma parameter of the distribution.

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

---

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

• boost_1_57_0/boost/random/cauchy_distribution.hpp