sRandomNumberGenerator.hh

Go to the documentation of this file.

/*
This file is part of CASToR.

    CASToR 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 (at your option) any later
    version.

    CASToR 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
    CASToR (in file GNU_GPL.TXT). If not, see <http://www.gnu.org/licenses/>.

Copyright 2017-2018 all CASToR contributors listed below:

    --> current contributors: Thibaut MERLIN, Simon STUTE, Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Mael MILLARDET
    --> past contributors: Valentin VIELZEUF

This is CASToR version 2.0.
*/

#ifndef SRANDOMNUMBERGENERATOR_HH
#define SRANDOMNUMBERGENERATOR_HH 1

#include "gVariables.hh"
#include "sOutputManager.hh"

class sRandomNumberGenerator
{
  // -------------------------------------------------------------------
  // Constructor & Destructor
  public:
    static sRandomNumberGenerator* GetInstance() 
    {
      if (mp_Instance == NULL) mp_Instance = new sRandomNumberGenerator();
      return mp_Instance;
    }


  // -------------------------------------------------------------------
  // Public member functions
  public:
    typedef mt19937 Engine; 
    typedef uniform_real_distribution<HPFLTNB> Distribution;  
    int Initialize(int a_nbThreads, int a_nbExtra);
    
    int Initialize(int64_t a_seed, int a_nbThreads, int a_nbExtra);
    HPFLTNB GenerateRdmNber();
    HPFLTNB GenerateExtraRdmNber(int a_nb = 0);
    Engine& GetExtraGenerator(int a_nb = 0);
    void SetVerbose(int a_verboseLevel) {m_verbose = a_verboseLevel;};


  // -------------------------------------------------------------------
  // Private member functions
  private:
    sRandomNumberGenerator();
    ~sRandomNumberGenerator();
    // Prevent the compiler generating methods of copy the object :
    sRandomNumberGenerator(sRandomNumberGenerator const&);     
    void operator=(sRandomNumberGenerator const&);


  // -------------------------------------------------------------------
  // Data members
  private:
    static sRandomNumberGenerator* mp_Instance;  
    int m_verbose;                               
    vector<Engine> mp_Engines;                   
    vector<Engine> mp_extraEngines;              
    Distribution mp_Distribution;                
    int64_t m_seed;                              
};

#endif