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 the documentation for a snapshot of the master branch, built from commit 25d613dfbc.
PrevUpHomeNext

Class template laplace_distribution

boost::random::laplace_distribution

Synopsis

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

template<typename RealType = double> 
class laplace_distribution {
public:
  // types
  typedef RealType result_type;
  typedef RealType input_type; 

  // member classes/structs/unions

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

    // construct/copy/destruct
    explicit param_type(RealType = 0.0, RealType = 1.0);

    // public member functions
    RealType mean() const;
    RealType beta() 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 > &, const param_type &);
    friend bool operator==(const param_type &, const param_type &);
    friend bool operator!=(const param_type &, const param_type &);
  };

  // construct/copy/destruct
  explicit laplace_distribution(RealType = 0.0, RealType = 1.0);
  explicit laplace_distribution(const param_type &);

  // public member functions
  template<typename URNG> RealType operator()(URNG &) const;
  template<typename URNG> 
    RealType operator()(URNG &, const param_type &) const;
  RealType mean() const;
  RealType beta() const;
  RealType min() const;
  RealType max() const;
  param_type param() const;
  void param(const param_type &);
  void reset();

  // friend functions
  template<typename CharT, typename Traits> 
    friend std::basic_ostream< CharT, Traits > & 
    operator<<(std::basic_ostream< CharT, Traits > &, 
               const laplace_distribution &);
  template<typename CharT, typename Traits> 
    friend std::basic_istream< CharT, Traits > & 
    operator>>(std::basic_istream< CharT, Traits > &, 
               const laplace_distribution &);
  friend bool operator==(const laplace_distribution &, 
                         const laplace_distribution &);
  friend bool operator!=(const laplace_distribution &, 
                         const laplace_distribution &);
};

Description

The laplace distribution is a real-valued distribution with two parameters, mean and beta.

It has .

laplace_distribution public construct/copy/destruct

  1. explicit laplace_distribution(RealType mean = 0.0, RealType beta = 1.0);

    Constructs an laplace_distribution from its "mean" and "beta" parameters.

  2. explicit laplace_distribution(const param_type & param);

    Constructs an laplace_distribution from its parameters.

laplace_distribution public member functions

  1. template<typename URNG> RealType operator()(URNG & urng) const;

    Returns a random variate distributed according to the laplace distribution.

  2. template<typename URNG> 
      RealType operator()(URNG & urng, const param_type & param) const;

    Returns a random variate distributed accordint to the laplace distribution with parameters specified by param.

  3. RealType mean() const;

    Returns the "mean" parameter of the distribution.

  4. RealType beta() const;

    Returns the "beta" parameter of the distribution.

  5. RealType min() const;

    Returns the smallest value that the distribution can produce.

  6. RealType max() const;

    Returns the largest value that the distribution can produce.

  7. param_type param() const;

    Returns the parameters of the distribution.

  8. void param(const param_type & param);

    Sets the parameters of the distribution.

  9. void reset();

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

laplace_distribution friend functions

  1. template<typename CharT, typename Traits> 
      friend std::basic_ostream< CharT, Traits > & 
      operator<<(std::basic_ostream< CharT, Traits > & os, 
                 const laplace_distribution & wd);

    Writes an laplace_distribution to a std::ostream.

  2. template<typename CharT, typename Traits> 
      friend std::basic_istream< CharT, Traits > & 
      operator>>(std::basic_istream< CharT, Traits > & is, 
                 const laplace_distribution & wd);

    Reads an laplace_distribution from a std::istream.

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

    Returns true if the two instances of laplace_distribution will return identical sequences of values given equal generators.

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

    Returns true if the two instances of laplace_distribution will return different sequences of values given equal generators.


PrevUpHomeNext