Class param_type

| Home | Libraries | People | FAQ | More

## Class param_type

boost::random::cauchy_distribution::param_type

## Synopsis

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

    class param_type {
    public:
      // types
      typedef cauchy_distribution distribution_type;

      // construct/copy/destruct
      explicit param_type(RealType = 0.0, RealType = 1.0);

      // public member functions
      RealType median() const;
      RealType sigma() const;
      RealType a() const;
      RealType b() const;

      // friend functions
      template<typename CharT, typename Traits>
        friend std::basic_ostream< CharT, Traits > &
        operator<<(std::basic_ostream< CharT, Traits > &, const param_type &);
      template<typename CharT, typename Traits>
        friend std::basic_istream< CharT, Traits > &
        operator>>(std::basic_istream< CharT, Traits > &, const param_type &);
      friend bool operator==(const param_type &, const param_type &);
      friend bool operator!=(const param_type &, const param_type &);
    };

## Description

### `param_type` public construct/copy/destruct

1.     explicit param_type(RealType median = 0.0, RealType sigma = 1.0);

   Constructs the parameters of the cauchy distribution.

### `param_type` public member functions

1.     RealType median() const;

   Returns the median of the distribution.

2.     RealType sigma() const;

   Returns the sigma parameter of the distribution.

3.     RealType a() const;

   Returns the median of the distribution.

4.     RealType b() const;

   Returns the sigma parameter of the distribution.

### `param_type` friend functions

1.     template<typename CharT, typename Traits>
         friend std::basic_ostream< CharT, Traits > &
         operator<<(std::basic_ostream< CharT, Traits > & os,
                    const param_type & param);

   Writes the parameters to a std::ostream.

2.     template<typename CharT, typename Traits>
         friend std::basic_istream< CharT, Traits > &
         operator>>(std::basic_istream< CharT, Traits > & is,
                    const param_type & param);

   Reads the parameters from a std::istream.

3.     friend bool operator==(const param_type & lhs, const param_type & rhs);

   Returns true if the two sets of parameters are equal.

4.     friend bool operator!=(const param_type & lhs, const param_type & rhs);

   Returns true if the two sets of parameters are different.