Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template geometric_distribution

boost::random::geometric_distribution

Synopsis

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

template<typename IntType, typename RealType> 
class geometric_distribution {
public:
  // types
  typedef  ; 
  typedef   ;

  // member classes/structs/unions

  class param_type {
  public:
    // types
    typedef geometric_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> 
     
    (, 
               geometric_distribution &);
  template<typename CharT, typename Traits> 
     
    (, 
               geometric_distribution &);
   (geometric_distribution &, 
                  geometric_distribution &);
   (geometric_distribution &, 
                  geometric_distribution &);
};

Description

An instantiation of the class template geometric_distribution models a random distribution . The distribution produces positive integers which are the number of bernoulli trials with probability p required to get one that fails.

For the geometric distribution, .

[Warning] Warning

This distribution has been updated to match the C++ standard. Its behavior has changed from the original boost::geometric_distribution. A backwards compatible wrapper is provided in namespace boost.

geometric_distribution public construct/copy/destruct

  1. ( p = );

    Contructs a new geometric_distribution with the paramter p.

    Requires: 0 < p < 1

  2. (param_type & param);

    Constructs a new geometric_distribution from its parameters.

geometric_distribution public member functions

  1.  () ;

    Returns: the distribution parameter p

  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 geometric_distribution.

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

    Returns a random variate distributed according to the geometric distribution with parameters specified by param.

geometric_distribution friend functions

  1. template<typename CharT, typename Traits> 
       
      ( os, 
                 geometric_distribution & gd);

    Writes the distribution to a std::ostream.

  2. template<typename CharT, typename Traits> 
       
      ( is, 
                 geometric_distribution & gd);

    Reads the distribution from a std::istream.

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

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

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

    Returns true if the two distributions may produce different sequences of values given equal generators.


PrevUpHomeNext