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