CLASS TEMPL(3)

NAME
boost::poisson_distribution

SYNOPSIS

// In header: <boost/random/poisson_distribution.hpp>
template<typename IntType = int, typename RealType = double>
class poisson_distribution {
public:
  // types
  typedef RealType input_type;
  typedef IntType  result_type;
  // construct/copy/destruct
  poisson_distribution(const RealType & = RealType(1));
  // public member functions
  RealType mean() const;
  void reset();
  template<typename Engine> result_type operator()(Engine &);
};

DESCRIPTION

An instantiation of the class template poisson_distribution is a model of random distribution . The poisson distribution has [1][IMAGE][2] [$p(i) = ac{e^{-}^i}{i!}$]

  poisson_distribution public construct/copy/destruct

    1.

    poisson_distribution(const RealType & mean_arg = RealType(1));

    Constructs a poisson_distribution with the parameter mean.

    Requires: mean > 0

  poisson_distribution public member functions

    1.

    RealType mean() const;

    Returns: the "mean" parameter of the distribution.

    2.

    void reset();

    3.

    template<typename Engine> result_type operator()(Engine & eng);