IConstraint.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/ParameterReference.h"
#include <string>
 
namespace Mantid {
namespace API {
//----------------------------------------------------------------------
// Forward declarations
//----------------------------------------------------------------------
class Expression;
class MANTID_API_DLL IConstraint : public ParameterReference {
public:
  virtual void initialize(IFunction *fun, const Expression &expr, bool isDefault = false) = 0;
 
  virtual double check() = 0;
 
  virtual double checkDeriv() = 0;
 
  virtual double checkDeriv2() = 0;
 
  virtual void setParamToSatisfyConstraint() = 0;
 
  virtual void setPenaltyFactor(const double &c) = 0;
 
  virtual double getPenaltyFactor() const = 0;
 
  virtual std::string asString() const = 0;
 
  static double getDefaultPenaltyFactor() { return m_defaultPenaltyFactor; }
 
protected:
  static constexpr double m_defaultPenaltyFactor = 1000;
};
 
} // namespace API
} // namespace Mantid