Package com.hexaly.optimizer

Class HxSolution

java.lang.Object
com.hexaly.optimizer.HxSolution
public class HxSolution extends Object
Solution to the optimization model. A solution carries the values of all expressions in the model. It is used to retrieve the values of all expressions (getting the solution), or to set the values of some decisions (setting the solution).
See Also:

  • Method Details

    • getOptimizer

      public HexalyOptimizer getOptimizer()
      Returns the Hexaly Optimizer object associated to this solution.
      Returns:
      Hexaly Optimizer object.

    • setValue

      public void setValue(HxExpression expr, long value)
      Sets the value of the given expression in this solution. Only decisions can be set. Only allowed in state HxState.Stopped. Only allowed if this expression is an integer or a boolean. If the optimizer was not launched, this value will be used as an initial value for the decision. This method has the same behavior as setIntValue(com.hexaly.optimizer.HxExpression, long).
      Parameters:
      expr - Decision.
      value - Value assigned to the decision in this solution.
      See Also:

    • setValue

      public void setValue(HxExpression expr, double value)
      Sets the value of the given expression in this solution. Only decisions can be set. Only allowed in state HxState.Stopped. Only allowed if this expression is a double. If the optimizer was not launched, this value will be used as an initial value for the decision. This method has the same behavior as setDoubleValue(com.hexaly.optimizer.HxExpression, double).
      Parameters:
      expr - Decision.
      value - Value assigned to the decision in this solution.
      See Also:

    • setValue

      public void setValue(HxExpression expr, HxInterval value)
      Sets the value of the given expression in this solution. Only decisions can be set. Only allowed in state HxState.Stopped. Only allowed if this expression is an interval. If the optimizer was not launched, this value will be used as an initial value for the decision. This method has the same behavior as setIntervalValue(com.hexaly.optimizer.HxExpression, com.hexaly.optimizer.HxInterval).
      Parameters:
      expr - Decision.
      value - Value assigned to the decision in this solution.
      See Also:

    • setIntValue

      public void setIntValue(HxExpression expr, long value)
      Sets the value of the given expression in this solution. Only decisions can be set. Only allowed in state HxState.Stopped. Only allowed if this expression is an integer or a boolean. If the optimizer was not launched, this value will be used as an initial value for the decision.
      Parameters:
      expr - Decision.
      value - Value assigned to the decision in this solution.
      Since:
      3.0
      See Also:

    • setDoubleValue

      public void setDoubleValue(HxExpression expr, double value)
      Sets the value of the given expression in this solution. Only decisions can be set. Only allowed in state HxState.Stopped. If the optimizer was not launched, this value will be used as an initial value for the decision. Only allowed if this expression is a double.
      Parameters:
      expr - Decision.
      value - Value assigned to the decision in this solution.
      Since:
      3.0
      See Also:

    • setIntervalValue

      public void setIntervalValue(HxExpression expr, HxInterval value)
      Sets the value of the given expression in this solution. Only decisions can be set. Only allowed in state HxState.Stopped. If the optimizer was not launched, this value will be used as an initial value for the decision. Only allowed if this expression is an interval.
      Parameters:
      expr - Decision.
      value - Value assigned to the decision in this solution.
      Since:
      3.0
      See Also:

    • getValue

      public long getValue(HxExpression expr)
      Returns the value of the given expression in this solution. Only allowed in states HxState.Paused or HxState.Stopped. Only allowed if this expression is an integer or a boolean. This method has the same behavior as getIntValue(HxExpression).
      Parameters:
      expr - Expression.
      Returns:
      Value of the expression in this solution.
      See Also:

    • getDoubleValue

      public double getDoubleValue(HxExpression expr)
      Returns the value of the given expression in this solution. Only allowed in states HxState.Paused or HxState.Stopped. Only allowed if this expression is a double.
      Parameters:
      expr - Expression.
      Returns:
      Value of the expression in this solution.
      Since:
      3.0
      See Also:

    • getIntValue

      public long getIntValue(HxExpression expr)
      Returns the value of the given expression in this solution. Only allowed in states HxState.Paused or HxState.Stopped. Only allowed if this expression is an integer or a boolean.
      Parameters:
      expr - Expression.
      Returns:
      Value of the expression in this solution.
      Since:
      3.0
      See Also:

    • getIntervalValue

      public HxInterval getIntervalValue(HxExpression expr)
      Returns the value of the given expression in this solution. Only allowed in states HxState.Paused or HxState.Stopped. Only allowed if this expression is an interval.
      Parameters:
      expr - Expression.
      Returns:
      Value of the expression in this solution.
      Since:
      12.0
      See Also:

    • getCollectionValue

      public HxCollection getCollectionValue(HxExpression expr)
      Returns the value of the given expression in this solution. Only allowed in states HxState.Paused or HxState.Stopped. Only allowed if this expression is a collection (list or set).
      Parameters:
      expr - Expression.
      Returns:
      Value of the expression in this solution.
      Since:
      5.5
      See Also:

    • getArrayValue

      public HxArray getArrayValue(HxExpression expr)
      Gets the value of this expression in the best solution found by the optimizer. Only allowed in states HxState.Paused or HxState.Stopped. Only allowed if this expression is an array.
      Returns:
      Value in the best solution.
      Since:
      7.5
      See Also:

    • isViolated

      public boolean isViolated(HxExpression expr)
      Returns true if the given expression is violated in this solution. An expression can be violated in 3 cases:
      1. It is a constraint and its value is 0.
      2. It is a double and its value is NaN (Not A Number).
      3. It is an integer or boolean with no valid value (arithmetic or out of bounds exception).
      Only allowed in states HxState.Paused or HxState.Stopped.
      Parameters:
      expr - Expression.
      Returns:
      True if this expression is violated in this solution.
      Since:
      5.5

    • isUndefined

      public boolean isUndefined(HxExpression expr)
      Returns true if the given expression has an undefined value in this solution. An expression can be undefined in 4 cases:
      1. It is a double and its value is NaN (Not a Number).
      2. It is an integer or boolean with no valid value (arithmetic or out of bounds exception).
      3. It is an interval with at least one undefined bound.
      4. It is the result of any ill-defined operation (at with out of bounds index or operations on undefined values for instance).
      Only allowed in states HxState.Paused or HxState.Stopped.
      Parameters:
      expr - Expression.
      Returns:
      True if this expression has an undefined value in this solution.
      Since:
      7.0

    • getStatus

      public HxSolutionStatus getStatus()
      Returns the status of the solution. Only allowed in states HxState.Paused or HxState.Stopped.
      Returns:
      Status of the solution.
      See Also:

    • getObjectiveBound

      public long getObjectiveBound(int objectiveIndex)
      Returns the bound computed by the optimizer for the given objective. If the optimizer has never been launched, this method returns Long.MIN_VALUE or Long.MAX_VALUE depending on the optimization direction of the objective. Only allowed in states HxState.Paused or HxState.Stopped. Only allowed if this expression is an integer or a boolean. This method has the same behavior as getIntObjectiveBound(int).
      Parameters:
      objectiveIndex - Index of the objective.
      Returns:
      Bound of the given objective.
      Since:
      8.5
      See Also:

    • getIntObjectiveBound

      public long getIntObjectiveBound(int objectiveIndex)
      Returns the bound computed by the optimizer for the given objective. If the optimizer has never been launched, this method returns Long.MIN_VALUE or Long.MAX_VALUE depending on the optimization direction of the objective. Only allowed in states HxState.Paused or HxState.Stopped. Only allowed if this expression is an integer or a boolean.
      Parameters:
      objectiveIndex - Index of the objective.
      Returns:
      Bound of the given objective.
      Since:
      8.5
      See Also:

    • getDoubleObjectiveBound

      public double getDoubleObjectiveBound(int objectiveIndex)
      Returns the bound computed by the optimizer for the given objective. If the optimizer has never been launched, this method returns Double.NEGATIVE_INFINITY or Double.POSITIVE_INFINITY depending on the optimization direction of the objective. Only allowed in states HxState.Paused or HxState.Stopped. Only allowed if this expression is a double.
      Parameters:
      objectiveIndex - Index of the objective.
      Returns:
      Bound of the given objective.
      Since:
      8.5
      See Also:

    • getObjectiveGap

      public double getObjectiveGap(int objectiveIndex)
      Returns the gap computed by the optimizer for the given objective. The gap for feasible solutions is defined as: |obj - bound| / max(1, |obj|, |bound|). Infeasible solutions have an infinite gap. Only allowed in states HxState.Paused or HxState.Stopped.
      Parameters:
      objectiveIndex - Index of the objective.
      Returns:
      Gap of the given objective.

    • clear

      public void clear()
      Clears the solution and set all decisions to zero. Only allowed in state HxState.Stopped.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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