Interpolation.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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/Unit.h"
#include <cstdlib>
#include <sstream>
#include <string>
#include <vector>
 
namespace Mantid {
namespace Kernel {
 
using DataXY = std::pair<double, double>;
class MANTID_KERNEL_DLL Interpolation {
private:
  std::vector<DataXY> m_data;
 
  std::string m_method;
 
  Unit_sptr m_xUnit;
 
  Unit_sptr m_yUnit;
 
protected:
  std::vector<DataXY>::const_iterator findIndexOfNextLargerValue(double key) const;
  std::vector<DataXY>::const_iterator cbegin() const;
  std::vector<DataXY>::const_iterator cend() const;
 
public:
  Interpolation();
  virtual ~Interpolation() = default;
 
  void addPoint(const double &xx, const double &yy);
 
  double value(const double &at) const;
 
  void setMethod(const std::string &method) { m_method = method; }
 
  const std::string &getMethod() const { return m_method; };
 
  void setXUnit(const std::string &unit);
 
  void setYUnit(const std::string &unit);
 
  Unit_sptr getXUnit() const { return m_xUnit; };
 
  Unit_sptr getYUnit() const { return m_yUnit; };
 
  bool containData() const { return !m_data.empty(); }
 
  void printSelf(std::ostream &os) const;
 
  void resetData();
};
 
// defining operator << and >>
MANTID_KERNEL_DLL std::ostream &operator<<(std::ostream &, const Interpolation &);
MANTID_KERNEL_DLL std::istream &operator>>(std::istream &, Interpolation &);
 
} // namespace Kernel
} // namespace Mantid