Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template bernoulli_distribution

boost::random::bernoulli_distribution

Synopsis

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

template<typename RealType> 
class bernoulli_distribution {
public:
  // types
  typedef   ; 
  typedef  ;

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef bernoulli_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 &);
  };

  // construct/copy/destruct
  ( = );
  (param_type &);

  // public member functions
   () ;
   () ;
   () ;
  param_type () ;
   (param_type &);
   ();
  template<typename Engine>  () ;
  template<typename Engine> 
     (, param_type &) ;

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

Description

Instantiations of class template bernoulli_distribution model a random distribution . Such a random distribution produces bool values distributed with probabilities P(true) = p and P(false) = 1-p. p is the parameter of the distribution.

bernoulli_distribution public construct/copy/destruct

  1. ( p = );

    Constructs a bernoulli_distribution object. p is the parameter of the distribution.

    Requires: 0 <= p <= 1

  2. (param_type & param);

    Constructs bernoulli_distribution from its parameters

bernoulli_distribution public member functions

  1.  () ;

    Returns: The "p" parameter of the distribution.

  2.  () ;

    Returns the smallest value that the distribution can produce.

  3.  () ;

    Returns the largest value that the distribution can produce.

  4. param_type () ;

    Returns the parameters of the distribution.

  5.  (param_type & param);

    Sets the parameters of the distribution.

  6.  ();

    Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.

  7. template<typename Engine>  ( eng) ;

    Returns: a random variate distributed according to the bernoulli_distribution .

  8. template<typename Engine> 
       ( eng, param_type & param) ;

    Returns: a random variate distributed according to the bernoulli_distribution with parameters specified by param.

bernoulli_distribution friend functions

  1. template<typename CharT, typename Traits> 
       
      ( os, 
                 bernoulli_distribution & bd);

    Writes the parameters of the distribution to a std::ostream.

  2. template<typename CharT, typename Traits> 
       
      ( is, 
                 bernoulli_distribution & bd);

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

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

    Returns true iff the two distributions will produce identical sequences of values given equal generators.

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

    Returns true iff the two distributions will produce different sequences of values given equal generators.


PrevUpHomeNext