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;

    // public member functions
    explicit param_type(RealType = 0.0, RealType = 1.0);
    RealType mean() const;
    RealType beta() const;

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

  // public member functions
  explicit laplace_distribution(RealType = 0.0, RealType = 1.0);
  explicit laplace_distribution(const param_type &);
  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> 
    std::basic_ostream< CharT, Traits > & 
    operator<<(std::basic_ostream< CharT, Traits > &, 
               const laplace_distribution &);
  template<typename CharT, typename Traits> 
    std::basic_istream< CharT, Traits > & 
    operator>>(std::basic_istream< CharT, Traits > &, 
               const laplace_distribution &);
  bool operator==(const laplace_distribution &, const laplace_distribution &);
  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 member functions

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

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

explicit laplace_distribution(const param_type & param);

Constructs an laplace_distribution from its parameters.

```
template<typename URNG> RealType operator()(URNG & urng) const;
```
Returns a random variate distributed according to the laplace distribution.
```
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.
```
RealType mean() const;
```
Returns the "mean" parameter of the distribution.
```
RealType beta() const;
```
Returns the "beta" parameter of the distribution.
```
RealType min() const;
```
Returns the smallest value that the distribution can produce.
```
RealType max() const;
```
Returns the largest value that the distribution can produce.
```
param_type param() const;
```
Returns the parameters of the distribution.
```
void param(const param_type & param);
```
Sets the parameters of the distribution.
```
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

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

Writes an laplace_distribution to a std::ostream.

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

Reads an laplace_distribution from a std::istream.

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.

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.

Boost C++ Libraries

Class template laplace_distribution

Synopsis

Description

laplace_distribution public member functions

laplace_distribution friend functions

`laplace_distribution` public member functions

`laplace_distribution` friend functions