RandomGenerator.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_RANDOMGENERATOR_H_
#define _MIRA_RANDOMGENERATOR_H_

#include <limits>

#ifndef Q_MOC_RUN
#include <boost/random/mersenne_twister.hpp>
#include <boost/random/variate_generator.hpp>
#include <boost/random/uniform_real.hpp>
#include <boost/random/uniform_int.hpp>
#endif

#include <platform/Types.h>
#include <utils/Time.h>

namespace mira {


template <typename Distribution, typename Engine=boost::mt19937>
class RandomGenerator
{
public:
    typedef typename Distribution::result_type result_type;

public:

    RandomGenerator() :
        mGenerator(mEngine, Distribution()) {
    }

    RandomGenerator(const Distribution& dist) :
        mGenerator(mEngine, dist) {
    }

    RandomGenerator(const RandomGenerator& other) :
        mGenerator(mEngine, other.distribution()) {
    }

public:

    RandomGenerator& operator=(const Distribution& dist) {
        mGenerator.distribution() = dist;
        return *this;
    }


    RandomGenerator& operator=(const RandomGenerator& other) {
        mGenerator.distribution() = other.distribution();
        return *this;
    }


public:

    result_type operator()() {
        return mGenerator();
    }

public:

    void seed() {
        seed((uint32)(Time::now()-Time::unixEpoch()).total_nanoseconds());
    }

    void seed(uint32 value) {
        mEngine.seed(value);
    }

public:

    Distribution* operator->() {
        return &mGenerator.distribution();
    }

    const Distribution* operator->() const {
        return &mGenerator.distribution();
    }

    Distribution& distribution() {
        return mGenerator.distribution();
    }

    const Distribution& distribution() const {
        return mGenerator.distribution();
    }

public:

    Engine& engine() {
        return mEngine;
    }

    const Engine& engine() const {
        return mEngine;
    }

private:

    Engine mEngine;
    // we can remove the variate_generator for boost >= 1.47
    boost::variate_generator<Engine&, Distribution> mGenerator;
};

#define MIRA_RANDOM_GENERATOR_COMMON(Derived, TDistribution)              \
    typedef RandomGenerator<TDistribution> Base;                          \
    typedef TDistribution Distribution;                                   \
    Derived(const Distribution& dist) : Base(dist) {}                     \
    Derived(const Derived& other) : Base(other) {}                        \
    Derived& operator=(const Distribution& dist) {                        \
        Base::operator=(dist);                                            \
        return *this;                                                     \
    }                                                                     \
    Derived& operator=(const Derived& other) {                            \
        Base::operator=(other);                                           \
        return *this;                                                     \
    }


} // namespace

#endif