Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

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 ;

  // 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 &);
};

Description

param_type public construct/copy/destruct

  1. ( median = ,  sigma = );

    Constructs the parameters of the cauchy distribution.

param_type public member functions

  1.  () ;

    Returns the median of the distribution.

  2.  () ;

    Returns the sigma parameter of the distribution.

  3.  () ;

    Returns the median of the distribution.

  4.  () ;

    Returns the sigma parameter of the distribution.

param_type friend functions

  1. template<typename CharT, typename Traits> 
       
      ( os, 
                 param_type & param);

    Writes the parameters to a std::ostream.

  2. template<typename CharT, typename Traits> 
       
      ( is, 
                 param_type & param);

    Reads the parameters from a std::istream.

  3.  (param_type & lhs, param_type & rhs);

    Returns true if the two sets of parameters are equal.

  4.  (param_type & lhs, param_type & rhs);

    Returns true if the two sets of parameters are different.


PrevUpHomeNext