Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is an old version of boost. Click here for the latest version's documentation home page.
PrevUpHomeNext

Class param_type

boost::random::negative_binomial_distribution::param_type

Synopsis

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



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

  // construct/copy/destruct
  explicit param_type(IntType = 1, RealType = 0.5);

  // public member functions
  IntType k() const;
  RealType p() 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 > &, 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(IntType k = 1, RealType p = 0.5);

    Construct a param_type object. k and p are the parameters of the distribution.

    Requires: k >=0 && 0 <= p <= 1

param_type public member functions

  1. IntType k() const;

    Returns the k parameter of the distribution.

  2. RealType p() const;

    Returns the p 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 of the distribution to a std::ostream.

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

    Reads the parameters of the distribution from a std::istream.

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

    Returns true if the parameters have the same values.

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

    Returns true if the parameters have different values.


PrevUpHomeNext