Class SQPoptimizer.OptimizationResult

java.lang.Object

neqsim.process.util.optimizer.SQPoptimizer.OptimizationResult

All Implemented Interfaces:

Serializable

Enclosing class:

SQPoptimizer

public static class SQPoptimizer.OptimizationResult
extends Object
implements Serializable

Optimization result container.

Version:

1.0

Author:

NeqSim

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	converged	Whether the optimizer converged.
private final int	iterations	Number of iterations performed.
private final double	kktError	Final KKT error.
private final double[]	optimalPoint	Optimal point.
private final double	optimalValue	Optimal objective value.
private static final long	serialVersionUID	Serialization version UID.

Constructor Summary

Constructors

Constructor	Description
OptimizationResult(double[] optimalPoint, double optimalValue, int iterations, boolean converged, double kktError)	Constructor for OptimizationResult.

Method Summary

Modifier and Type	Method	Description
int	getIterations()	Get the number of iterations.
double	getKktError()	Get the final KKT error.
double[]	getOptimalPoint()	Get the optimal point.
double	getOptimalValue()	Get the optimal objective value.
boolean	isConverged()	Check if the optimizer converged.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

Serialization version UID.

See Also:

• Constant Field Values

optimalPoint

private final double[] optimalPoint

Optimal point.

optimalValue

private final double optimalValue

Optimal objective value.

iterations

private final int iterations

Number of iterations performed.

converged

private final boolean converged

Whether the optimizer converged.

kktError

private final double kktError

Final KKT error.

Constructor Details

OptimizationResult

public OptimizationResult(double[] optimalPoint,
 double optimalValue,
 int iterations,
 boolean converged,
 double kktError)

Constructor for OptimizationResult.

Parameters:

optimalPoint - optimal variable values

optimalValue - optimal objective value

iterations - number of iterations

converged - whether converged

kktError - final KKT error

Method Details

getOptimalPoint

public double[] getOptimalPoint()

Get the optimal point.

Returns:

optimal variable values

getOptimalValue

public double getOptimalValue()

Get the optimal objective value.

Returns:

minimum objective value found

getIterations

public int getIterations()

Get the number of iterations.

Returns:

iteration count

isConverged

public boolean isConverged()

Check if the optimizer converged.

Returns:

true if converged to tolerance

getKktError

public double getKktError()

Get the final KKT error.

Returns:

KKT optimality error