BoundaryConstraint.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/IConstraint.h"
#include "MantidCurveFitting/DllConfig.h"
 
namespace Mantid {
namespace CurveFitting {
namespace Constraints {
//----------------------------------------------------------------------
// Forward Declaration
//----------------------------------------------------------------------
 
class MANTID_CURVEFITTING_DLL BoundaryConstraint : public API::IConstraint {
public:
  BoundaryConstraint();
 
  BoundaryConstraint(const std::string &paramName);
 
  BoundaryConstraint(API::IFunction *fun, const std::string &paramName, const double lowerBound,
                     const double upperBound, bool isDefault = false);
 
  BoundaryConstraint(API::IFunction *fun, const std::string &paramName, const double lowerBound,
                     bool isDefault = false);
 
  void initialize(API::IFunction *fun, const API::Expression &expr, bool isDefault) override;
 
  void setPenaltyFactor(const double &c) override;
  double getPenaltyFactor() const override { return m_penaltyFactor; }
 
  bool hasLower() const { return m_hasLowerBound; }
  bool hasUpper() const { return m_hasUpperBound; }
  const double &lower() const { return m_lowerBound; }
  const double &upper() const { return m_upperBound; }
 
  void setLower(const double &value) {
    m_hasLowerBound = true;
    m_lowerBound = value;
  }
  void setUpper(const double &value) {
    m_hasUpperBound = true;
    m_upperBound = value;
  }
  void clearLower() {
    m_hasLowerBound = false;
    m_lowerBound = double();
  }
  void clearUpper() {
    m_hasUpperBound = false;
    m_upperBound = double();
  }
 
  void setBounds(const double &lower, const double &upper) {
    setLower(lower);
    setUpper(upper);
  }
 
  void clearBounds() {
    clearLower();
    clearUpper();
  }
 
  //  std::string getParameterName() const { return m_parameterName; }
 
  double check() override;
  double checkDeriv() override;
  double checkDeriv2() override;
  void setParamToSatisfyConstraint() override;
  std::string asString() const override;
 
private:
  double m_penaltyFactor;
 
  // std::string m_parameterName;
 
  bool m_hasLowerBound;
  bool m_hasUpperBound;
  double m_lowerBound;
  double m_upperBound;
};
 
} // namespace Constraints
} // namespace CurveFitting
} // namespace Mantid