Chris@16: /* boost random/uniform_int.hpp header file
Chris@16:  *
Chris@16:  * Copyright Jens Maurer 2000-2001
Chris@16:  * Distributed under the Boost Software License, Version 1.0. (See
Chris@16:  * accompanying file LICENSE_1_0.txt or copy at
Chris@16:  * http://www.boost.org/LICENSE_1_0.txt)
Chris@16:  *
Chris@16:  * See http://www.boost.org for most recent version including documentation.
Chris@16:  *
Chris@101:  * $Id$
Chris@16:  *
Chris@16:  * Revision history
Chris@16:  *  2001-04-08  added min<max assertion (N. Becker)
Chris@16:  *  2001-02-18  moved to individual header files
Chris@16:  */
Chris@16: 
Chris@16: #ifndef BOOST_RANDOM_UNIFORM_INT_HPP
Chris@16: #define BOOST_RANDOM_UNIFORM_INT_HPP
Chris@16: 
Chris@16: #include <boost/assert.hpp>
Chris@16: #include <boost/random/uniform_int_distribution.hpp>
Chris@16: 
Chris@16: namespace boost {
Chris@16: 
Chris@16: /**
Chris@16:  * The distribution function uniform_int models a \random_distribution.
Chris@16:  * On each invocation, it returns a random integer value uniformly
Chris@16:  * distributed in the set of integer numbers {min, min+1, min+2, ..., max}.
Chris@16:  *
Chris@16:  * The template parameter IntType shall denote an integer-like value type.
Chris@16:  *
Chris@16:  * This class is deprecated.  Please use @c uniform_int_distribution in
Chris@16:  * new code.
Chris@16:  */
Chris@16: template<class IntType = int>
Chris@16: class uniform_int : public random::uniform_int_distribution<IntType>
Chris@16: {
Chris@16:     typedef random::uniform_int_distribution<IntType> base_type;
Chris@16: public:
Chris@16: 
Chris@16:     class param_type : public base_type::param_type
Chris@16:     {
Chris@16:     public:
Chris@16:         typedef uniform_int distribution_type;
Chris@16:         /**
Chris@16:          * Constructs the parameters of a uniform_int distribution.
Chris@16:          *
Chris@16:          * Requires: min <= max
Chris@16:          */
Chris@16:         explicit param_type(IntType min_arg = 0, IntType max_arg = 9)
Chris@16:           : base_type::param_type(min_arg, max_arg)
Chris@16:         {}
Chris@16:     };
Chris@16: 
Chris@16:     /**
Chris@16:      * Constructs a uniform_int object. @c min and @c max are
Chris@16:      * the parameters of the distribution.
Chris@16:      *
Chris@16:      * Requires: min <= max
Chris@16:      */
Chris@16:     explicit uniform_int(IntType min_arg = 0, IntType max_arg = 9)
Chris@16:       : base_type(min_arg, max_arg)
Chris@16:     {}
Chris@16: 
Chris@16:     /** Constructs a uniform_int distribution from its parameters. */
Chris@16:     explicit uniform_int(const param_type& parm)
Chris@16:       : base_type(parm)
Chris@16:     {}
Chris@16: 
Chris@16:     /** Returns the parameters of the distribution */
Chris@16:     param_type param() const { return param_type(this->a(), this->b()); }
Chris@16:     /** Sets the parameters of the distribution. */
Chris@16:     void param(const param_type& parm) { this->base_type::param(parm); }
Chris@16: 
Chris@16:     // Codergear seems to have trouble with a using declaration here
Chris@16: 
Chris@16:     template<class Engine>
Chris@16:     IntType operator()(Engine& eng) const
Chris@16:     {
Chris@16:         return static_cast<const base_type&>(*this)(eng);
Chris@16:     }
Chris@16: 
Chris@16:     template<class Engine>
Chris@16:     IntType operator()(Engine& eng, const param_type& parm) const
Chris@16:     {
Chris@16:         return static_cast<const base_type&>(*this)(eng, parm);
Chris@16:     }
Chris@16: 
Chris@16:     template<class Engine>
Chris@16:     IntType operator()(Engine& eng, IntType n) const
Chris@16:     {
Chris@16:         BOOST_ASSERT(n > 0);
Chris@16:         return static_cast<const base_type&>(*this)(eng, param_type(0, n - 1));
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: } // namespace boost
Chris@16: 
Chris@16: #endif // BOOST_RANDOM_UNIFORM_INT_HPP