FunctionGenerator.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
 
#include "MantidAPI/IFunction.h"
 
namespace Mantid {
namespace API {
class MANTID_API_DLL FunctionGenerator : public IFunction {
public:
  FunctionGenerator(const IFunction_sptr &source);
 
 
 
  void setParameter(size_t, const double &value, bool explicitlySet = true) override;
  void setParameterDescription(size_t, const std::string &description) override;
  double getParameter(size_t i) const override;
  void setParameter(const std::string &name, const double &value, bool explicitlySet = true) override;
  void setParameterDescription(const std::string &name, const std::string &description) override;
  double getParameter(const std::string &name) const override;
  bool hasParameter(const std::string &name) const override;
  size_t nParams() const override;
  size_t parameterIndex(const std::string &name) const override;
  std::string parameterName(size_t i) const override;
  std::string parameterDescription(size_t i) const override;
  bool isExplicitlySet(size_t i) const override;
  double getError(size_t i) const override;
  double getError(const std::string &name) const override;
  void setError(size_t i, double err) override;
  void setError(const std::string &name, double err) override;
 
  size_t getParameterIndex(const ParameterReference &ref) const override;
  void setUpForFit() override;
  ParameterTie *getTie(size_t i) const override;
  IConstraint *getConstraint(size_t i) const override;
 
  virtual void buildTargetFunction() const = 0;
 
protected:
  void declareParameter(const std::string &name, double initValue = 0, const std::string &description = "") override;
  void setParameterStatus(size_t i, ParameterStatus status) override;
  ParameterStatus getParameterStatus(size_t i) const override;
 
public:
  size_t nAttributes() const override;
  std::vector<std::string> getAttributeNames() const override;
  Attribute getAttribute(const std::string &name) const override;
  void setAttribute(const std::string &name, const Attribute &) override;
  bool hasAttribute(const std::string &name) const override;
  // Get ith attribute name
  std::string attributeName(size_t i) const override;
 
 
  void function(const FunctionDomain &domain, FunctionValues &values) const override;
 
protected:
  void init() override;
  void setSource(IFunction_sptr source) const;
 
  virtual bool isSourceName(const std::string &aName) const;
  virtual void updateTargetFunction() const = 0;
  void checkTargetFunction() const;
  mutable IFunction_sptr m_source;
  mutable IFunction_sptr m_target;
  mutable size_t m_nOwnParams;
  mutable bool m_dirty;
};
 
} // namespace API
} // namespace Mantid