| Home | Libraries | People | FAQ | More

## Class template beta_distribution

boost::random::beta_distribution

## Synopsis

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

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

      // member classes/structs/unions

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

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

        // public member functions
        RealType alpha() 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 beta_distribution(RealType = 1.0, RealType = 1.0);
      explicit beta_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 alpha() 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 beta_distribution &);
      template<typename CharT, typename Traits>
        friend std::basic_istream< CharT, Traits > &
        operator>>(std::basic_istream< CharT, Traits > &,
                   const beta_distribution &);
      friend bool operator==(const beta_distribution &, const beta_distribution &);
      friend bool operator!=(const beta_distribution &, const beta_distribution &);
    };

## Description

The beta distribution is a real-valued distribution which produces values in the range [0, 1]. It has two parameters, alpha and beta.

It has .

### `beta_distribution` public construct/copy/destruct

1.     explicit beta_distribution(RealType alpha = 1.0, RealType beta = 1.0);

   Constructs an ``beta_distribution`` from its "alpha" and "beta" parameters.

   Requires: alpha > 0, beta > 0

2.     explicit beta_distribution(const param_type & param);

   Constructs an ``beta_distribution`` from its parameters.

### `beta_distribution` public member functions

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

   Returns a random variate distributed according to the beta distribution.

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

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

3.     RealType alpha() const;

   Returns the "alpha" 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.

### `beta_distribution` friend functions

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

   Writes an ``beta_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 beta_distribution & wd);

   Reads an ``beta_distribution`` from a `std::istream`.

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

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

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

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