TabulatedFunction.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 "MantidAPI/IFunction1D.h"
#include "MantidAPI/ParamFunction.h"
#include "MantidCurveFitting/DllConfig.h"
#include <cmath>
 
namespace Mantid {
 
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
namespace API {
class MatrixWorkspace;
}
 
namespace CurveFitting {
namespace Functions {
class MANTID_CURVEFITTING_DLL TabulatedFunction : public API::ParamFunction, public API::IFunction1D {
public:
  TabulatedFunction();
 
  std::string name() const override { return "TabulatedFunction"; }
  const std::string category() const override { return "General"; }
  void function1D(double *out, const double *xValues, const size_t nData) const override;
  void functionDeriv1D(API::Jacobian *out, const double *xValues, const size_t nData) override;
 
  size_t nAttributes() const override;
  std::vector<std::string> getAttributeNames() const override;
  Attribute getAttribute(const std::string &attName) const override;
  void setAttribute(const std::string &attName, const IFunction::Attribute &value) override;
 
private:
  void load(const std::string &fname);
 
  void loadWorkspace(const std::string &wsName) const;
 
  void loadWorkspace(std::shared_ptr<API::MatrixWorkspace> ws) const;
 
  size_t size() const { return m_yData.size(); }
 
  void clear() const;
 
  void eval(double scaling, double xshift, double xscale, double *out, const double *xValues, const size_t nData) const;
 
  void setupData() const;
 
  static const int defaultIndexValue;
 
  mutable std::shared_ptr<API::MatrixWorkspace> m_workspace;
 
  mutable std::vector<double> m_xData;
 
  mutable std::vector<double> m_yData;
 
  mutable bool m_setupFinished;
 
  mutable bool m_explicitXY;
};
 
} // namespace Functions
} // namespace CurveFitting
} // namespace Mantid