NDRandomNumberGenerator.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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 <vector>
 
namespace Mantid {
namespace Kernel {
class MANTID_KERNEL_DLL NDRandomNumberGenerator {
public:
  NDRandomNumberGenerator(const unsigned int ndims);
  virtual ~NDRandomNumberGenerator() = default;
 
  NDRandomNumberGenerator() = delete;
 
  NDRandomNumberGenerator(const NDRandomNumberGenerator &) = delete;
 
  NDRandomNumberGenerator &operator=(const NDRandomNumberGenerator &) = delete;
 
  inline unsigned int numberOfDimensions() const { return m_ndims; }
  const std::vector<double> &nextPoint();
 
  virtual void restart() = 0;
  virtual void save() = 0;
  virtual void restore() = 0;
 
protected:
  virtual void generateNextPoint() = 0;
 
  void cacheGeneratedValue(const size_t index, const double value);
  void cacheNextPoint(const std::vector<double> &nextPoint);
  inline std::vector<double> &getNextPointCache() { return m_nextPoint; }
 
private:
  const unsigned int m_ndims;
  std::vector<double> m_nextPoint;
};
} // namespace Kernel
} // namespace Mantid