Class SensitivityAnalysis.SensitivityResult

java.lang.Object

neqsim.process.util.optimizer.SensitivityAnalysis.SensitivityResult

All Implemented Interfaces:

Serializable

Enclosing class:

SensitivityAnalysis

public static class SensitivityAnalysis.SensitivityResult
extends Object
implements Serializable

Results of a sensitivity analysis sweep.

Version:

1.0

Author:

Even Solbraa

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,double[]>	outputs	Output values for each tracked variable.
private final String	parameterName	Name of the varied parameter.
private final double[]	parameterValues	Values of the varied parameter.
private static final long	serialVersionUID	Serialization version.
private final boolean[]	succeeded	Whether each step succeeded.

Constructor Summary

Constructors

Constructor	Description
SensitivityResult(String parameterName, double[] parameterValues, Map<String,double[]> outputs, boolean[] succeeded)	Creates a sensitivity result.

Method Summary

Modifier and Type	Method	Description
double[]	getOutput(String outputName)	Gets the output values for a named output variable.
List<String>	getOutputNames()	Gets all output names.
double[]	getParameterValues()	Gets the parameter values used in the sweep.
int	getSize()	Gets the number of evaluation points.
int	getSuccessCount()	Gets the number of successful evaluations.
String	toCSV()	Converts results to CSV format.
String	toJson()	Converts results to a JSON string.

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.

See Also:

• Constant Field Values

parameterName

private final String parameterName

Name of the varied parameter.

parameterValues

private final double[] parameterValues

Values of the varied parameter.

outputs

private final Map<String,double[]> outputs

Output values for each tracked variable.

succeeded

private final boolean[] succeeded

Whether each step succeeded.

Constructor Details

SensitivityResult

SensitivityResult(String parameterName,
 double[] parameterValues,
 Map<String,double[]> outputs,
 boolean[] succeeded)

Creates a sensitivity result.

Parameters:

parameterName - name of varied parameter

parameterValues - array of parameter values

outputs - map of output name to value arrays

succeeded - success flag per step

Method Details

getParameterValues

public double[] getParameterValues()

Gets the parameter values used in the sweep.

Returns:

array of parameter values

getOutput

public double[] getOutput(String outputName)

Gets the output values for a named output variable.

Parameters:

outputName - name of the output

Returns:

array of output values, or null if not found

getOutputNames

public List<String> getOutputNames()

Gets all output names.

Returns:

list of output names

getSize

public int getSize()

Gets the number of evaluation points.

Returns:

number of steps

getSuccessCount

public int getSuccessCount()

Gets the number of successful evaluations.

Returns:

count of succeeded evaluations

toJson

public String toJson()

Converts results to a JSON string.

Returns:

JSON representation

toCSV

public String toCSV()

Converts results to CSV format.

Returns:

CSV string with header row