UserFunction.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 <memory>
 
namespace mu {
class Parser;
}
 
namespace Mantid {
namespace CurveFitting {
namespace Functions {
class MANTID_CURVEFITTING_DLL UserFunction : public API::ParamFunction, public API::IFunction1D {
public:
  UserFunction();
  ~UserFunction() override;
 
  std::string name() const override { return "UserFunction"; }
  // Returns Category
  const std::string category() const override { return "General"; }
 
  void function1D(double *out, const double *xValues, const size_t nData) const override;
  void functionDeriv(const API::FunctionDomain &domain, API::Jacobian &jacobian) override;
 
  size_t nAttributes() const override { return 1; }
  std::vector<std::string> getAttributeNames() const override { return std::vector<std::string>(1, "Formula"); }
  Attribute getAttribute(const std::string &attName) const override {
    return attName == "Formula" ? Attribute(m_formula) : getAttribute(attName);
  }
  void setAttribute(const std::string &attName, const Attribute &value) override;
  bool hasAttribute(const std::string &attName) const override { return attName == "Formula"; }
 
private:
  std::string m_formula;
  mu::Parser *m_parser;
  mutable double m_x;
  bool m_x_set;
  mutable std::vector<double> m_tmp;
  mutable std::vector<double> m_tmp1;
 
  static double *AddVariable(const char *varName, void *pufun);
};
 
} // namespace Functions
} // namespace CurveFitting
} // namespace Mantid