ParamFunction.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/DllConfig.h"
#include "MantidAPI/IConstraint.h"
#include "MantidAPI/IFunction.h"
#include "MantidAPI/ParameterTie.h"
#include <string>
#include <vector>
 
namespace Mantid {
namespace API {
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
class Jacobian;
class MANTID_API_DLL ParamFunction : public virtual IFunction {
public:
  ParamFunction() {}
 
  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 { return m_parameters.size(); }
  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;
  IFunction_sptr getContainingFunction(const ParameterReference &ref) const;
  IFunction_sptr getContainingFunction(IFunction_sptr fun);
 
protected:
  void declareParameter(const std::string &name, double initValue = 0, const std::string &description = "") override;
  virtual double *getParameterAddress(size_t i);
  void clearAllParameters();
  void setParameterStatus(size_t i, ParameterStatus status) override;
  ParameterStatus getParameterStatus(size_t i) const override;
 
private:
  inline void checkParameterIndex(size_t i) const {
    if (i >= nParams()) {
      throw std::out_of_range("ParamFunction parameter index " + std::to_string(i) + " out of range " +
                              std::to_string(nParams()));
    }
  }
  std::vector<ParameterStatus> m_parameterStatus;
  std::vector<std::string> m_parameterNames;
  std::vector<double> m_parameters;
  std::vector<double> m_errors;
  std::vector<bool> m_explicitlySet;
  std::vector<std::string> m_parameterDescriptions;
};
 
} // namespace API
} // namespace Mantid