NDPseudoRandomNumberGenerator.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include "MantidKernel/DllConfig.h"
#include "MantidKernel/NDRandomNumberGenerator.h"
#ifndef Q_MOC_RUN
#include <memory>
#endif
 
namespace Mantid {
namespace Kernel {
template <typename SingleValueGenerator> class NDPseudoRandomNumberGenerator : public NDRandomNumberGenerator {
public:
  NDPseudoRandomNumberGenerator(const unsigned int ndims, const size_t seedValue);
  NDPseudoRandomNumberGenerator(const unsigned int ndims, const size_t seedValue, const double start, const double end);
 
  NDPseudoRandomNumberGenerator() = delete;
 
  NDPseudoRandomNumberGenerator(const NDPseudoRandomNumberGenerator &) = delete;
 
  NDPseudoRandomNumberGenerator &operator=(const NDPseudoRandomNumberGenerator &) = delete;
 
  void setSeed(const size_t seedValue);
  void generateNextPoint() override;
  void restart() override;
  void save() override;
  void restore() override;
 
private:
  SingleValueGenerator m_singleValueGen;
};
 
//-------------------------------------------------------------------------------------------------------
// Implementation
//-------------------------------------------------------------------------------------------------------
 
template <typename SingleValueGenerator>
NDPseudoRandomNumberGenerator<SingleValueGenerator>::NDPseudoRandomNumberGenerator(const unsigned int ndims,
                                                                                   const size_t seedValue)
    : NDRandomNumberGenerator(ndims), m_singleValueGen(seedValue) {}
 
template <typename SingleValueGenerator>
NDPseudoRandomNumberGenerator<SingleValueGenerator>::NDPseudoRandomNumberGenerator(const unsigned int ndims,
                                                                                   const size_t seedValue,
                                                                                   const double start, const double end)
    : NDRandomNumberGenerator(ndims), m_singleValueGen(seedValue, start, end) {}
 
template <typename SingleValueGenerator>
void NDPseudoRandomNumberGenerator<SingleValueGenerator>::setSeed(const size_t seedValue) {
  m_singleValueGen.setSeed(seedValue);
}
 
template <typename SingleValueGenerator> void NDPseudoRandomNumberGenerator<SingleValueGenerator>::generateNextPoint() {
  for (unsigned int i = 0; i < numberOfDimensions(); ++i) {
    this->cacheGeneratedValue(i, m_singleValueGen.nextValue());
  }
}
 
template <typename SingleValueGenerator> void NDPseudoRandomNumberGenerator<SingleValueGenerator>::restart() {
  m_singleValueGen.restart();
}
 
template <typename SingleValueGenerator> void NDPseudoRandomNumberGenerator<SingleValueGenerator>::save() {
  m_singleValueGen.save();
}
 
template <typename SingleValueGenerator> void NDPseudoRandomNumberGenerator<SingleValueGenerator>::restore() {
  m_singleValueGen.restore();
}
} // namespace Kernel
} // namespace Mantid