Class OptimizationResultBase

java.lang.Object
neqsim.process.util.optimizer.OptimizationResultBase
All Implemented Interfaces:
Serializable
public class OptimizationResultBase extends Object implements Serializable
Base class for all optimization results in the NeqSim optimization framework.

This class provides a unified structure for optimization results, including:

  • Convergence status and iteration count
  • Optimal values and objective function value
  • Constraint violation tracking
  • Sensitivity information
  • Performance metrics (timing, evaluations)

Specialized result classes should extend this base to add domain-specific fields.

Version:
1.0
Author:
NeqSim Development Team
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serialization version UID.
      See Also:

    • status

      private OptimizationResultBase.Status status

    • converged

      private boolean converged

    • objective

      private String objective

    • optimalValue

      private double optimalValue

    • objectiveValue

      private double objectiveValue

    • errorMessage

      private String errorMessage

    • iterations

      private int iterations

    • functionEvaluations

      private int functionEvaluations

    • constraintEvaluations

      private int constraintEvaluations

    • startTimeMillis

      private long startTimeMillis

    • endTimeMillis

      private long endTimeMillis

    • constraintViolations

      private List<OptimizationResultBase.ConstraintViolation> constraintViolations

    • constraintMargins

      private Map<String,Double> constraintMargins

    • bottleneckEquipment

      private String bottleneckEquipment

    • bottleneckConstraint

      private String bottleneckConstraint

    • sensitivities

      private Map<String,Double> sensitivities

    • shadowPrices

      private Map<String,Double> shadowPrices

    • optimalValues

      private Map<String,Double> optimalValues

    • initialValues

      private Map<String,Double> initialValues

  • Constructor Details

    • OptimizationResultBase

      public OptimizationResultBase()
      Default constructor.

  • Method Details

    • getStatus

      public OptimizationResultBase.Status getStatus()

    • setStatus

      public void setStatus(OptimizationResultBase.Status status)

    • isConverged

      public boolean isConverged()

    • setConverged

      public void setConverged(boolean converged)

    • getObjective

      public String getObjective()

    • setObjective

      public void setObjective(String objective)

    • getOptimalValue

      public double getOptimalValue()

    • setOptimalValue

      public void setOptimalValue(double optimalValue)

    • getObjectiveValue

      public double getObjectiveValue()

    • setObjectiveValue

      public void setObjectiveValue(double objectiveValue)

    • getErrorMessage

      public String getErrorMessage()

    • setErrorMessage

      public void setErrorMessage(String errorMessage)

    • getIterations

      public int getIterations()

    • setIterations

      public void setIterations(int iterations)

    • incrementIterations

      public void incrementIterations()

    • getFunctionEvaluations

      public int getFunctionEvaluations()

    • setFunctionEvaluations

      public void setFunctionEvaluations(int functionEvaluations)

    • incrementFunctionEvaluations

      public void incrementFunctionEvaluations()

    • getConstraintEvaluations

      public int getConstraintEvaluations()

    • setConstraintEvaluations

      public void setConstraintEvaluations(int constraintEvaluations)

    • incrementConstraintEvaluations

      public void incrementConstraintEvaluations()

    • markStart

      public void markStart()
      Marks the start of optimization.

    • markEnd

      public void markEnd()
      Marks the end of optimization.

    • getStartTimeMillis

      public long getStartTimeMillis()

    • getEndTimeMillis

      public long getEndTimeMillis()

    • getElapsedTimeMillis

      public long getElapsedTimeMillis()
      Gets the elapsed time in milliseconds.
      Returns:
      elapsed time

    • getElapsedTimeSeconds

      public double getElapsedTimeSeconds()
      Gets the elapsed time in seconds.
      Returns:
      elapsed time in seconds

    • getConstraintViolations

      public List<OptimizationResultBase.ConstraintViolation> getConstraintViolations()

    • setConstraintViolations

      public void setConstraintViolations(List<OptimizationResultBase.ConstraintViolation> violations)

    • addConstraintViolation

      public void addConstraintViolation(OptimizationResultBase.ConstraintViolation violation)

    • addConstraintViolation

      public void addConstraintViolation(String equipment, String constraint, double current, double limit, String unit, boolean hard)

    • hasViolations

      public boolean hasViolations()

    • hasHardViolations

      public boolean hasHardViolations()

    • getConstraintMargins

      public Map<String,Double> getConstraintMargins()

    • setConstraintMargins

      public void setConstraintMargins(Map<String,Double> margins)

    • addConstraintMargin

      public void addConstraintMargin(String name, double margin)

    • getBottleneckEquipment

      public String getBottleneckEquipment()

    • setBottleneckEquipment

      public void setBottleneckEquipment(String bottleneckEquipment)

    • getBottleneckConstraint

      public String getBottleneckConstraint()

    • setBottleneckConstraint

      public void setBottleneckConstraint(String bottleneckConstraint)

    • getSensitivities

      public Map<String,Double> getSensitivities()

    • setSensitivities

      public void setSensitivities(Map<String,Double> sensitivities)

    • addSensitivity

      public void addSensitivity(String name, double value)

    • getShadowPrices

      public Map<String,Double> getShadowPrices()

    • setShadowPrices

      public void setShadowPrices(Map<String,Double> shadowPrices)

    • addShadowPrice

      public void addShadowPrice(String constraint, double price)

    • getOptimalValues

      public Map<String,Double> getOptimalValues()

    • setOptimalValues

      public void setOptimalValues(Map<String,Double> optimalValues)

    • addOptimalValue

      public void addOptimalValue(String name, double value)

    • getInitialValues

      public Map<String,Double> getInitialValues()

    • setInitialValues

      public void setInitialValues(Map<String,Double> initialValues)

    • addInitialValue

      public void addInitialValue(String name, double value)

    • getSummary

      public String getSummary()
      Gets a summary string of the result.
      Returns:
      summary string

    • toString

      public String toString()
      Overrides:
      toString in class Object