FunctionDomain1D.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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 "MantidAPI/FunctionDomain.h"
 
#include <span>
#include <vector>
 
namespace Mantid {
namespace API {
class MANTID_API_DLL FunctionDomain1D : public FunctionDomain {
public:
  FunctionDomain1D(const FunctionDomain1D &right) = delete;
  FunctionDomain1D &operator=(const FunctionDomain1D &) = delete;
  size_t size() const override { return m_n; }
  double operator[](size_t i) const { return m_data[i]; }
  const double *getPointerAt(size_t i) const { return m_data + i; }
  std::vector<double> toVector() const;
  void setPeakRadius(int radius);
  int getPeakRadius() const;
 
protected:
  FunctionDomain1D(const double *x, size_t n);
  void resetData(const double *x, size_t n) {
    m_data = x;
    m_n = n;
  }
 
private:
  const double *m_data;
  size_t m_n;
  int m_peakRadius;
};
 
class MANTID_API_DLL FunctionDomain1DVector : public FunctionDomain1D {
public:
  FunctionDomain1DVector(const double x);
  FunctionDomain1DVector(const double startX, const double endX, const size_t n);
  FunctionDomain1DVector(const std::vector<double> &xvalues);
  FunctionDomain1DVector(std::span<double const> xvalues);
  FunctionDomain1DVector(std::vector<double> &&xvalues);
  FunctionDomain1DVector(std::vector<double>::const_iterator from, std::vector<double>::const_iterator to);
  FunctionDomain1DVector(const FunctionDomain1DVector &);
  FunctionDomain1DVector &operator=(const FunctionDomain1DVector &);
  const std::vector<double> &getVector() { return m_X; }
 
protected:
  std::vector<double> m_X; 
};
 
class MANTID_API_DLL FunctionDomain1DView : public FunctionDomain1D {
public:
  FunctionDomain1DView(const double *x, size_t n) : FunctionDomain1D(x, n) {}
 
private:
  FunctionDomain1DView(const FunctionDomain1DView &);
  FunctionDomain1DView &operator=(const FunctionDomain1DView &);
};
 
class MANTID_API_DLL FunctionDomain1DSpectrum : public FunctionDomain1DVector {
public:
  FunctionDomain1DSpectrum(size_t wi, const std::vector<double> &xvalues);
  FunctionDomain1DSpectrum(size_t wi, std::vector<double>::const_iterator from, std::vector<double>::const_iterator to);
  size_t getWorkspaceIndex() const { return m_workspaceIndex; }
 
private:
  size_t m_workspaceIndex;
};
 
class MANTID_API_DLL FunctionDomain1DHistogram : public FunctionDomain1D {
public:
  FunctionDomain1DHistogram(const std::vector<double> &bins);
  FunctionDomain1DHistogram(std::vector<double>::const_iterator from, std::vector<double>::const_iterator to);
 
  FunctionDomain1DHistogram(const FunctionDomain1DHistogram &) = delete;
 
  FunctionDomain1DHistogram &operator=(const FunctionDomain1DHistogram &) = delete;
 
  double leftBoundary() const;
 
protected:
  std::vector<double> m_bins; 
};
 
using FunctionDomain1D_sptr = std::shared_ptr<FunctionDomain1D>;
using FunctionDomain1D_const_sptr = std::shared_ptr<const FunctionDomain1D>;
 
} // namespace API
} // namespace Mantid