Package com.hexaly.optimizer

Class HxSurrogateParameters

java.lang.Object
com.hexaly.optimizer.HxSurrogateParameters
public class HxSurrogateParameters extends Object
Parameters specific to the surrogate modeling feature. Surrogate parameters can be used to query and set the evaluation budget and the evaluation points of the associated external function.
Since:
9.5
See Also:

  • Method Details

    • getEvaluationLimit

      public int getEvaluationLimit()
      Returns the maximum number of evaluations. The default number of evaluations is set to the largest positive integer on 32 bits, that is 2^32-1 = 2,147,483,647 > 10^9.
      Returns:
      The maximum number of calls to the external function.

    • setEvaluationLimit

      public void setEvaluationLimit(int evaluationLimit)
      Sets the maximum number of evaluations. The default number of evaluations is set to the largest positive integer on 32 bits, that is 2^32-1 = 2,147,483,647 > 10^9. Only allowed in states HxState.Modeling or HxState.Stopped.
      Parameters:
      evaluationLimit - The maximum number of calls to the external function.

    • createEvaluationPoint

      public HxEvaluationPoint createEvaluationPoint()
      Creates an evaluation point for the external function. It consists of a list of values corresponding to the function's arguments and return value. Evaluation points are used to specify known points for a function in advance. It can be useful to warm-start the optimizer when the function is particularly expensive to evaluate, or if you already have a good estimate of the optimal point. Only allowed in states HxState.Modeling or HxState.Stopped.
      Returns:
      Evaluation point.
      See Also:

    • getNbEvaluationPoints

      public int getNbEvaluationPoints()
      Returns the number of evaluation points.
      Returns:
      The number of evaluation points.

    • getEvaluationPoint

      public HxEvaluationPoint getEvaluationPoint(int pos)
      Returns the evaluation point at the given position.
      Parameters:
      pos - Position of the evaluation point.
      Returns:
      Evaluation point at the given position.
      See Also:

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object