![]() |
Home | Libraries | People | FAQ | More |
boost::random::cauchy_distribution
// In header: <boost/random/cauchy_distribution.hpp> template<typename RealType = double> class cauchy_distribution { public: // types typedef RealType ; typedef RealType ; // member classes/structs/unions class param_type { public: // types typedef cauchy_distribution ; // construct/copy/destruct (RealType = , RealType = ); // public member functions RealType () ; RealType () ; RealType () ; RealType () ; // friend functions template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const param_type &); template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const param_type &); bool (const param_type &, const param_type &); bool (const param_type &, const param_type &); }; // construct/copy/destruct (RealType = , RealType = ); (const param_type &); // public member functions RealType () ; RealType () ; RealType () ; RealType () ; RealType () ; RealType () ; param_type () ; void (const param_type &); void (); template<typename Engine> result_type (Engine &); template<typename Engine> result_type (Engine &, const param_type &); // friend functions template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const cauchy_distribution &); template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const cauchy_distribution &); bool (const cauchy_distribution &, const cauchy_distribution &); bool (const cauchy_distribution &, const cauchy_distribution &); };
The cauchy distribution is a continuous distribution with two parameters, median and sigma.
It has
cauchy_distribution
public
construct/copy/destruct(RealType median = , RealType sigma = );
Constructs a cauchy_distribution
with the paramters median
and sigma
.
(const param_type & param);
Constructs a cauchy_distribution
from it's parameters.
cauchy_distribution
public member functionsRealType () ;
Returns: the "median" parameter of the distribution
RealType () ;
Returns: the "sigma" parameter of the distribution
RealType () ;
Returns: the "median" parameter of the distribution
RealType () ;
Returns: the "sigma" parameter of the distribution
RealType () ;
Returns the smallest value that the distribution can produce.
RealType () ;
Returns the largest value that the distribution can produce.
param_type () ;
void (const param_type & param);
void ();
Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.
template<typename Engine> result_type (Engine & eng);
Returns: A random variate distributed according to the cauchy distribution.
template<typename Engine> result_type (Engine & eng, const param_type & param);
Returns: A random variate distributed according to the cauchy distribution with parameters specified by param.
cauchy_distribution
friend functionstemplate<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > & os, const cauchy_distribution & cd);
Writes the distribution to a std::ostream
.
template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > & is, const cauchy_distribution & cd);
Reads the distribution from a std::istream
.
bool (const cauchy_distribution & lhs, const cauchy_distribution & rhs);
Returns true if the two distributions will produce identical sequences of values, given equal generators.
bool (const cauchy_distribution & lhs, const cauchy_distribution & rhs);
Returns true if the two distributions may produce different sequences of values, given equal generators.