RandomNumberGenerator.hpp

/*

Copyright (c) 2005-2018, University of Oxford.
All rights reserved.

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of Chaste.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of the University of Oxford nor the names of its
   contributors may be used to endorse or promote products derived from this
   software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

#ifndef RANDOMNUMBERGENERATORS_HPP_
#define RANDOMNUMBERGENERATORS_HPP_

#include <boost/shared_ptr.hpp>
#include <boost/version.hpp>
#include <sstream>

#if BOOST_VERSION < 106400
// Forward compatibility with Boost 1.64 onwards
#include "Boost165NormalDistribution.hpp"
#endif

#include <boost/random.hpp>

#include <boost/serialization/split_member.hpp>
#include "ChasteSerialization.hpp"
#include "SerializableSingleton.hpp"

class RandomNumberGenerator : public SerializableSingleton<RandomNumberGenerator>
{
private:
    boost::mt19937 mMersenneTwisterGenerator;

    // If you add any more generators below, then remember to add lines for them in the Reseed() method too.

    boost::variate_generator<boost::mt19937&, boost::uniform_real<> > mGenerateUnitReal;

#if BOOST_VERSION < 106400 // #2585 and #2893
    boost::variate_generator<boost::mt19937&, boost::random::normal_distribution_v165<> > mGenerateStandardNormal;
#else
    boost::variate_generator<boost::mt19937&, boost::normal_distribution<> > mGenerateStandardNormal;
#endif

    static RandomNumberGenerator* mpInstance;

    friend class boost::serialization::access;
    template <class Archive>
    void save(Archive& archive, const unsigned int version) const
    {
        std::stringstream rng_internals;
        rng_internals << mMersenneTwisterGenerator;
        std::string rng_internals_string = rng_internals.str();
        archive& rng_internals_string;

        std::stringstream normal_internals;
#if BOOST_VERSION < 106400 // #2585 and #2893
        const boost::random::normal_distribution_v165<>& r_normal_dist = mGenerateStandardNormal.distribution();
#else
        const boost::normal_distribution<>& r_normal_dist = mGenerateStandardNormal.distribution();
#endif
        normal_internals << r_normal_dist;
        std::string normal_internals_string = normal_internals.str();
        archive& normal_internals_string;
    }

    template <class Archive>
    void load(Archive& archive, const unsigned int version)
    {
        std::string rng_internals_string;
        archive& rng_internals_string;
        std::stringstream rng_internals(rng_internals_string);
        rng_internals >> mMersenneTwisterGenerator;

        std::string normal_internals_string;
        archive& normal_internals_string;
        std::stringstream normal_internals(normal_internals_string);
        normal_internals >> mGenerateStandardNormal.distribution();
    }
    BOOST_SERIALIZATION_SPLIT_MEMBER()

protected:
    RandomNumberGenerator();

public:
    double StandardNormalRandomDeviate();

    double NormalRandomDeviate(double mean, double stdDev);

    double ranf();

    double GammaRandomDeviate(double shape, double scale);

    double ExponentialRandomDeviate(double scale);

    unsigned randMod(unsigned base);

    template <class T>
    void Shuffle(std::vector<boost::shared_ptr<T> >& rValues)
    {
        unsigned num = rValues.size();
        if (num == 0)
        {
            return;
        }
        for (unsigned end = num - 1; end > 0; end--)
        {
            // Pick a random integer from {0,..,end}
            unsigned k = RandomNumberGenerator::Instance()->randMod(end + 1);
            boost::shared_ptr<T> temp = rValues[end];
            rValues[end] = rValues[k];
            rValues[k] = temp;
        }
    }

    void Shuffle(unsigned num, std::vector<unsigned>& rValues);

    static RandomNumberGenerator* Instance();

    static void Destroy();

    void Reseed(unsigned seed);
};

#endif /*RANDOMNUMBERGENERATORS_HPP_*/