Class param_type

Boost C++ Libraries

Class param_type

boost::random::cauchy_distribution::param_type

Synopsis

// In header: <boost/random/cauchy_distribution.hpp>



class param_type {
public:
  // types
  typedef  ;

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

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

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

Description

`param_type` public construct/copy/destruct

```
( median = ,  sigma = );
```
Constructs the parameters of the cauchy distribution.

`param_type` public member functions

```
 () ;
```
Returns the median of the distribution.
```
 () ;
```
Returns the sigma parameter of the distribution.
```
 () ;
```
Returns the median of the distribution.
```
 () ;
```
Returns the sigma parameter of the distribution.

`param_type` friend functions

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

Writes the parameters to a std::ostream.

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

Reads the parameters from a std::istream.

```
 ( lhs,  rhs);
```
Returns true if the two sets of parameters are equal.
```
 ( lhs,  rhs);
```
Returns true if the two sets of parameters are different.