java.lang.Object
org.hipparchus.optim.nonlinear.vector.constrained.SQPOption
All Implemented Interfaces:
OptimizationData

public class SQPOption extends Object implements OptimizationData
Parameter for SQP Algorithm.
Since:
3.1
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final double
    Default parameter for alpha min during line search.
    static final double
    Default parameter for quadratic line search.
    static final int
    Deprecated.
    as of 4.1, only used by deprecated SQPOptimizerS and SQPOptimizerGM; will be removed in 5.0
    static final double
    Default tolerance for convergence and active constraint(proportional to sqrt of function an constraints evaluation accuracy)
    static final double
    Default tolerance for QP convergence(proportional to function and constraints evaluation accuracy)
    static final double
    Default Gradient EPS (proportional to function and constraints evaluation accuracy).
    static final GradientMode
    Default Gradient mode.
    static final int
    Default parameter for non monotone line search history.
    static final int
    Default Max Iterations.
    static final int
    Default max iteration before reset hessian.
    static final double
    Default parameter for evaluation of Armijo condition for descend direction.
    static final int
    Default max iteration admitted for QP subproblem.
    static final double
    Default weight for augmented QP subproblem.
    static final double
    Default max value admitted for additional variable in QP subproblem.
    static final boolean
    Default flag for using BFGS update formula.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Simple constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    double
    Get parameter line search alpha min.
    double
    Get parameter for quadratic line search.
    int
    Deprecated.
    as of 4.1, only used by deprecated SQPOptimizerS and SQPOptimizerGM; will be removed in 5.0
    Get Convergence criteria Function
    double
    Get tolerance for convergence and active constraint evaluation.
    double
    Get tolerance for QP convergence
    double
    Get Gradient Eps.
    Get Gradient Mode.
    int
    Get parameter fot non-monotone line search history.
    int
    Get max Iteration
    int
    Get max Iteration for the line search
    double
    Get parameter for evaluation of Armijo condition for descend direction.
    int
    Get max iteration admitted for QP subproblem evaluation.
    double
    Get weight for augmented QP subproblem.
    double
    Get max value admitted for the solution of the additional variable in QP subproblem.
    void
    setAlphaMin(double alphaMin)
    Set parameter for line search alpha min.
    void
    setB(double b)
    Set parameter for quadratic line search.
    void
    setConvCriteria(int convCriteria)
    Deprecated.
    as of 4.1, only used by deprecated SQPOptimizerS and SQPOptimizerGM; will be removed in 5.0
    void
    Set custom convergence criteria function
    void
    setEps(double eps)
    Set tolerance for convergence Choose value proportional to sqrt of function and constraints evaluation accuracy
    void
    setEpsQP(double epsQP)
    Set tolerance for QP convergence Choose value proportional to function and constraints evaluation accuracy
    void
    setGradientEps(double gradientEps)
    Set Gradient Eps Choose value proportional to function and constraints evaluation accuracy)
    void
    Set Gradient mode
    void
    setHistory(int history)
    Set parameter for non-monotone line search history.
    void
    setMaxIteration(int maxIteration)
    Set max Iteration
    void
    setMaxLineSearchIteration(int maxLineSearchIteration)
    Set max Iteration for the line search
    void
    setMu(double mu)
    Set parameter for evaluation of Armijo condition for descend direction.
    void
    setQpMaxLoop(int qpMaxLoop)
    Set max iteration admitted for QP subproblem evaluation.
    void
    setRhoCons(double rhoCons)
    Set weight for augmented QP subproblem.
    void
    setSigmaMax(double sigmaMax)
    Set max value admitted for the solution of the additional variable in QP subproblem.
    void
    setUseFunHessian(boolean useFunHessian)
    Enable or Disable using direct the function Hessian.
    boolean
    Check if using direct the function Hessian is enabled or disabled.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • DEFAULT_CONV_CRITERIA

      @Deprecated public static final int DEFAULT_CONV_CRITERIA
      Deprecated.
      as of 4.1, only used by deprecated SQPOptimizerS and SQPOptimizerGM; will be removed in 5.0
      Default convergence criteria.
      See Also:
    • DEFAULT_EPSILON

      public static final double DEFAULT_EPSILON
      Default tolerance for convergence and active constraint(proportional to sqrt of function an constraints evaluation accuracy)
      See Also:
    • DEFAULT_EPSILON_QP

      public static final double DEFAULT_EPSILON_QP
      Default tolerance for QP convergence(proportional to function and constraints evaluation accuracy)
    • DEFAULT_RHO

      public static final double DEFAULT_RHO
      Default weight for augmented QP subproblem.
      See Also:
    • DEFAULT_SIGMA_MAX

      public static final double DEFAULT_SIGMA_MAX
      Default max value admitted for additional variable in QP subproblem.
      See Also:
    • DEFAULT_QP_MAX_LOOP

      public static final int DEFAULT_QP_MAX_LOOP
      Default max iteration admitted for QP subproblem.
      See Also:
    • DEFAULT_MU

      public static final double DEFAULT_MU
      Default parameter for evaluation of Armijo condition for descend direction.
      See Also:
    • DEFAULT_B

      public static final double DEFAULT_B
      Default parameter for quadratic line search.
      See Also:
    • DEFAULT_ALPHA_MIN

      public static final double DEFAULT_ALPHA_MIN
      Default parameter for alpha min during line search.
      See Also:
    • DEFAULT_HISTORY

      public static final int DEFAULT_HISTORY
      Default parameter for non monotone line search history.
      See Also:
    • DEFAULT_USE_FUNCTION_HESSIAN

      public static final boolean DEFAULT_USE_FUNCTION_HESSIAN
      Default flag for using BFGS update formula.
      See Also:
    • DEFAULT_MAX_LINE_SEARCH_ITERATION

      public static final int DEFAULT_MAX_LINE_SEARCH_ITERATION
      Default max iteration before reset hessian.
      See Also:
    • DEFAULT_GRADIENT_MODE

      public static final GradientMode DEFAULT_GRADIENT_MODE
      Default Gradient mode.
    • DEFAULT_GRAD_EPS

      public static final double DEFAULT_GRAD_EPS
      Default Gradient EPS (proportional to function and constraints evaluation accuracy).
    • DEFAULT_MAX_ITERATION

      public static final int DEFAULT_MAX_ITERATION
      Default Max Iterations.
      See Also:
  • Constructor Details

    • SQPOption

      public SQPOption()
      Simple constructor.

      This constructor uses all defaults values.

  • Method Details

    • setGradientMode

      public void setGradientMode(GradientMode gradientMode)
      Set Gradient mode
      Parameters:
      gradientMode - gradient mode
    • getGradientMode

      public GradientMode getGradientMode()
      Get Gradient Mode.
      Returns:
      Gradient Mode
    • setGradientEps

      public void setGradientEps(double gradientEps)
      Set Gradient Eps Choose value proportional to function and constraints evaluation accuracy)
      Parameters:
      gradientEps - gradient mode
    • getGradientEps

      public double getGradientEps()
      Get Gradient Eps.
      Returns:
      Gradient Eps
    • setConvCriteria

      @Deprecated public void setConvCriteria(int convCriteria)
      Deprecated.
      as of 4.1, only used by deprecated SQPOptimizerS and SQPOptimizerGM; will be removed in 5.0
      Set convergence criteria.
      Parameters:
      convCriteria - convergence criteria
    • getConvCriteria

      @Deprecated public int getConvCriteria()
      Deprecated.
      as of 4.1, only used by deprecated SQPOptimizerS and SQPOptimizerGM; will be removed in 5.0
      Get convergence criteria.
      Returns:
      convergence criteria
    • setEps

      public void setEps(double eps)
      Set tolerance for convergence Choose value proportional to sqrt of function and constraints evaluation accuracy
      Parameters:
      eps - tolerance for convergence and active constraint evaluation
    • getEps

      public double getEps()
      Get tolerance for convergence and active constraint evaluation.
      Returns:
      tolerance for convergence and active constraint evaluation
    • setEpsQP

      public void setEpsQP(double epsQP)
      Set tolerance for QP convergence Choose value proportional to function and constraints evaluation accuracy
      Parameters:
      epsQP - tolerance for convergence
    • getEpsQP

      public double getEpsQP()
      Get tolerance for QP convergence
      Returns:
      tolerance for QP convergence
    • setRhoCons

      public void setRhoCons(double rhoCons)
      Set weight for augmented QP subproblem.
      Parameters:
      rhoCons - weight for augmented QP subproblem
    • getRhoCons

      public double getRhoCons()
      Get weight for augmented QP subproblem.
      Returns:
      weight for augmented QP subproblem
    • setSigmaMax

      public void setSigmaMax(double sigmaMax)
      Set max value admitted for the solution of the additional variable in QP subproblem.
      Parameters:
      sigmaMax - max value admitted for the solution of the additional variable in QP subproblem
    • getSigmaMax

      public double getSigmaMax()
      Get max value admitted for the solution of the additional variable in QP subproblem.
      Returns:
      max value admitted for the solution of the additional variable in QP subproblem
    • setQpMaxLoop

      public void setQpMaxLoop(int qpMaxLoop)
      Set max iteration admitted for QP subproblem evaluation.
      Parameters:
      qpMaxLoop - max iteration admitted for QP subproblem evaluation
    • getQpMaxLoop

      public int getQpMaxLoop()
      Get max iteration admitted for QP subproblem evaluation.
      Returns:
      max iteration admitted for QP subproblem evaluation
    • setMu

      public void setMu(double mu)
      Set parameter for evaluation of Armijo condition for descend direction.
      Parameters:
      mu - parameter for evaluation of Armijo condition for descend direction
    • getMu

      public double getMu()
      Get parameter for evaluation of Armijo condition for descend direction.
      Returns:
      parameter for evaluation of Armijo condition for descend direction
    • setB

      public void setB(double b)
      Set parameter for quadratic line search.
      Parameters:
      b - parameter for quadratic line search
    • getB

      public double getB()
      Get parameter for quadratic line search.
      Returns:
      parameter for quadratic line search
    • setAlphaMin

      public void setAlphaMin(double alphaMin)
      Set parameter for line search alpha min.
      Parameters:
      alphaMin - parameter line search
    • getAlphaMin

      public double getAlphaMin()
      Get parameter line search alpha min.
      Returns:
      parameter for quadratic line search
    • setHistory

      public void setHistory(int history)
      Set parameter for non-monotone line search history.
      Parameters:
      history - parameter line search
    • getHistory

      public int getHistory()
      Get parameter fot non-monotone line search history.
      Returns:
      parameter for non-monotone line search history
    • setMaxLineSearchIteration

      public void setMaxLineSearchIteration(int maxLineSearchIteration)
      Set max Iteration for the line search
      Parameters:
      maxLineSearchIteration - max Iteration for the line search
    • getMaxLineSearchIteration

      public int getMaxLineSearchIteration()
      Get max Iteration for the line search
      Returns:
      max Iteration for the line search
    • setMaxIteration

      public void setMaxIteration(int maxIteration)
      Set max Iteration
      Parameters:
      maxIteration - max Iteration
    • getMaxIteration

      public int getMaxIteration()
      Get max Iteration
      Returns:
      max Iteration
    • setUseFunHessian

      public void setUseFunHessian(boolean useFunHessian)
      Enable or Disable using direct the function Hessian.
      Parameters:
      useFunHessian - enable or Disable using direct the function Hessian
    • useFunHessian

      public boolean useFunHessian()
      Check if using direct the function Hessian is enabled or disabled.
      Returns:
      true if using direct the function Hessian is enabled
    • setConvergenceFunction

      public void setConvergenceFunction(SQPCustomCriterion fun)
      Set custom convergence criteria function
      Parameters:
      fun - convergence criteria function
    • getConvergenceFunction

      public SQPCustomCriterion getConvergenceFunction()
      Get Convergence criteria Function
      Returns:
      the function of the custom convergenc criteria