RnMan.h

Go to the documentation of this file.

/*
 *  This is free software: you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  any later version.
 *  The software is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *  You should have received a copy of the GNU General Public License
 *  along with the software. If not, see <http://www.gnu.org/licenses/>.
 *
 *  Copyright 2018, Kuylen E, Willem L, Broeckhove J
 */

#pragma once

#include "RnInfo.h"

#include <functional>
#include <memory>
#include <vector>

namespace stride {
namespace util {

class RnEngine;

/*
 * RnMan manages random engines and distribution to produce random generators.
 * Can be used with (up to 32) parallel streams out of the engine.
 */
class RnMan
{
public:
        RnMan();

        explicit RnMan(const RnInfo& info);

        bool operator==(const RnMan& other);

        RnInfo GetInfo() const;

        std::function<double()> GetUniform01Generator(unsigned int i = 0U);

        std::function<int()> GetUniformIntGenerator(int a, int b, unsigned int i = 0U);

        std::function<int()> GetDiscreteGenerator(const std::vector<double>& weights, unsigned int i = 0U);

        bool MakeWeightedCoinFlip(double fraction, unsigned int i = 0U);

        void Initialize(const RnInfo& info);

        bool IsEmpty() const;

        void Shuffle(std::vector<unsigned int>& indices, unsigned int i);

private:
        std::shared_ptr<RnEngine> m_rn;
};

} // namespace util
} // namespace stride