Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class param_type

boost::random::fisher_f_distribution::param_type

Synopsis

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



class param_type {
public:
  // types
  typedef fisher_f_distribution ;

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

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

  // friend functions
  template<typename CharT, typename Traits> 
    CharT, Traits > & 
    (CharT, Traits > &, const param_type &);
  template<typename CharT, typename Traits> 
    CharT, Traits > & 
    (CharT, Traits > &, const param_type &);
  bool (const param_type &, const param_type &);
  bool (const param_type &, const param_type &);
};

Description

param_type public construct/copy/destruct

  1. (RealType m = , RealType n = );

    Constructs a param_type from the "m" and "n" parameters of the distribution.

    Requires: m > 0 and n > 0

param_type public member functions

  1. RealType () ;

    Returns the "m" parameter of the distribtuion.

  2. RealType () ;

    Returns the "n" parameter of the distribution.

param_type friend functions

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

    Writes a param_type to a std::ostream.

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

    Reads a param_type from a std::istream.

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

    Returns true if the two sets of parameters are the same.

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

    Returns true if the two sets of parameters are the different.


PrevUpHomeNext