| Home | Libraries | People | FAQ | More

## Class param_type

boost::uniform_smallint::param_type

## Synopsis

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

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

      // public member functions
      param_type(IntType = 0, IntType = 9);
      IntType a() const;
      IntType b() 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 &);
    };

## Description

### `param_type` public member functions

1.     param_type(IntType min = 0, IntType max = 9);

   constructs the parameters of a `uniform_smallint` distribution.

2.     IntType a() const;

   Returns the minimum value.

3.     IntType b() const;

   Returns the maximum value.

### `param_type` friend functions

1.     template<typename CharT, typename Traits>
         std::basic_ostream< CharT, Traits > &
         operator<<(std::basic_ostream< CharT, Traits > & os,
                    const param_type & param);

   Writes the parameters to a `std::ostream`.

2.     template<typename CharT, typename Traits>
         std::basic_istream< CharT, Traits > &
         operator>>(std::basic_istream< CharT, Traits > & is,
                    const param_type & param);

   Reads the parameters from a `std::istream`.

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

   Returns true if the two sets of parameters are equal.

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

   Returns true if the two sets of parameters are different.