rnd.h

Go to the documentation of this file.

/* Brush
copyright 2020 William La Cava
license: GNU/GPL v3
*/
 
#ifndef RND_H
#define RND_H
//external includes
#include <random>
#include <limits>
#include <vector>
 
#include "../init.h"
 
// Defines a multi-core random number generator and its operators.
 
using namespace std;
using std::swap;
 
namespace Brush { namespace Util{
    
    
    class Rnd
    {
        public:
            
            static Rnd* initRand();
            
            static void destroy();
 
            void set_seed(unsigned int seed);
            
            int rnd_int( int lowerLimit, int upperLimit );
 
            float rnd_flt(float min=0.0, float max=1.0);
 
            float rnd_dbl(float min=0.0, float max=1.0);
            
            float operator()(unsigned i);
            
            float operator()();
 
            template <class RandomAccessIterator>
            void shuffle (RandomAccessIterator first, RandomAccessIterator last)
            {
                for (auto i=(last-first)-1; i>0; --i) 
                {
                    std::uniform_int_distribution<decltype(i)> d(0,i);
                    swap (first[i], first[d(rg[omp_get_thread_num()])]);
                }
            }    
 
            vector<size_t> shuffled_index(size_t n);
             
            template<typename Iter>                                    
            Iter select_randomly(Iter start, Iter end)
            {
                std::uniform_int_distribution<> dis(0, distance(start, end) - 1);
                advance(start, dis(rg[omp_get_thread_num()]));
                return start;
            }
 
            // The probability of picking the i-th element is w_i/S, with S
            // being the sum of all weights. select_randomly works even if the
            // weights does not sum up to 1
            template<typename Iter, typename Iter2>                                    
            Iter select_randomly(Iter start, Iter end, Iter2 wstart, Iter2 wend)
            {
                // discrete_distribution creates a Generator for a probability
                // distribution function. `dis` generate integers from [0, s),
                // where `s` is the number of probabilities in the iterator 
                // passed as argument. To generate a new value, the
                // `operator()( Generator& g )` needs a uniform random bit
                // generator object, which is stored in `rg`.
 
                // std::uniform_int_distribution<> dis(0, distance(start, end) - 1);
                std::discrete_distribution<size_t> dis(wstart, wend);
 
                // `advance(it, n)` increments the iterator by n elements
                advance(start, dis(rg[omp_get_thread_num()]));
 
                // start was originally an iterator pointing to the beggining
                // of the sequence we want to take a random value. It is incremented
                // to point to a random element, with probabilities taken from 
                // the second iterator Iter2.
                return start;
            }
           
            template<typename T>
            T random_choice(const map<T, float>& m)
            {
                assert(m.size()>0 
                    && " attemping to return random choice from an empty map");
 
                vector<T> keys;
                vector<float> w; 
                for (const auto& [k, v]: m)
                {
                    keys.push_back(k);
                    w.push_back(v);
                }
                return *select_randomly(keys.begin(),keys.end(),
                                        w.begin(), w.end());
            }
            template<class V, class T>
            T random_choice(const V& v)
            {
                assert(v.size()>0 
                    && " attemping to return random choice from empty vector");
                return *select_randomly(v.begin(),v.end());
            }
           
            template<template<class, class> class C, class T>
            T random_choice(const C<T, std::allocator<T>>& v, const vector<float>& w )
            {
                if(w.size() == 0)
                {   
                    fmt::format("w size = {} and v size = {}, returning uniform random choice\n",
                        w.size(), v.size());
                    return random_choice(v);
                }
                if(w.size() != v.size())
                {   
                    fmt::format("w ({}) != v size ({}), returning uniform random choice\n",
                        w.size(), v.size());
                    return random_choice(v);
                }
                else
                {
                    assert(v.size() == w.size());
                    std::discrete_distribution<size_t> dis(w.begin(), w.end());
                    return v.at(dis(rg[omp_get_thread_num()])); 
                }
            }
            
            float gasdev();
 
        private:
 
            Rnd();
        
            ~Rnd();
            
            // Vector of pseudo-random number generators, one for each thread
            vector<std::mt19937> rg;
            
            // private static attribute used by every instance of the class.
            // All threads share common static members of the class
            static Rnd* instance;
    };
    
    // `Brush.Util` static attribute holding an singleton instance of Rnd.
    // the instance is created by calling `initRand`, which creates
    // an instance of the private static attribute `instance`. `r` will contain
    // one generator for each thread (since it called the constructor) 
    static Rnd &r = *Rnd::initRand();
} // Util
} // Brush
#endif