Class template cauchy

Class template cauchy_distribution

boost::random::cauchy_distribution

Synopsis

// 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  ;

    // construct/copy/destruct
    ( = ,  = );

    // public member functions
     () ;
     () ;
     () ;
     () ;

    // friend functions
    template<typename CharT, typename Traits> 
       
      (, );
    template<typename CharT, typename Traits> 
       
      (, );
     (, );
     (, );
  };

  // 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> 
     
    (, 
               );
  template<typename CharT, typename Traits> 
     
    (, 
               );
   (, );
   (, );
};

Description

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 functions

template<typename CharT, typename Traits> 
   
  ( os, 
              cd);

Writes the distribution to a std::ostream.

template<typename CharT, typename Traits> 
   
  ( is, 
              cd);

Reads the distribution from a std::istream.

```
 ( lhs, 
                 rhs);
```
Returns true if the two distributions will produce identical sequences of values, given equal generators.
```
 ( lhs, 
                 rhs);
```
Returns true if the two distributions may produce different sequences of values, given equal generators.

Class template cauchy_distribution

Synopsis

Description

cauchy_distribution public construct/copy/destruct

cauchy_distribution public member functions

cauchy_distribution friend functions

`cauchy_distribution` public construct/copy/destruct

`cauchy_distribution` public member functions

`cauchy_distribution` friend functions