Class template bernoulli

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  ;

    // construct/copy/destruct
    ( = );

    // public member functions
     () ;

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

  // 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> 
     
    (, 
               );
  template<typename CharT, typename Traits> 
     
    (, 
               );
   (, 
                  );
   (, 
                  );
};

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

```
( p = );
```
Constructs a bernoulli_distribution object. p is the parameter of the distribution.

Requires: 0 <= p <= 1
```
(param_type & param);
```
Constructs bernoulli_distribution from its parameters

`bernoulli_distribution` public member functions

```
 () ;
```
Returns: The "p" parameter of the distribution.
```
 () ;
```
Returns the smallest value that the distribution can produce.
```
 () ;
```
Returns the largest value that the distribution can produce.
```
param_type () ;
```
Returns the parameters of the distribution.
```
 (param_type & param);
```
Sets the parameters of the distribution.
```
 ();
```
Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.
```
template<typename Engine>  ( eng) ;
```
Returns: a random variate distributed according to the bernoulli_distribution .
```
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

template<typename CharT, typename Traits> 
   
  ( os, 
              bd);

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

template<typename CharT, typename Traits> 
   
  ( is, 
              bd);

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

```
 ( lhs, 
                 rhs);
```
Returns true iff the two distributions will produce identical sequences of values given equal generators.
```
 ( lhs, 
                 rhs);
```
Returns true iff the two distributions will produce different sequences of values given equal generators.

Class template bernoulli_distribution

Synopsis

Description

bernoulli_distribution public construct/copy/destruct

bernoulli_distribution public member functions

bernoulli_distribution friend functions

`bernoulli_distribution` public construct/copy/destruct

`bernoulli_distribution` public member functions

`bernoulli_distribution` friend functions