Class SensitivityAnalysis.TrialResult

java.lang.Object

neqsim.process.util.fielddevelopment.SensitivityAnalysis.TrialResult

All Implemented Interfaces:

Serializable, Comparable<SensitivityAnalysis.TrialResult>

Enclosing class:

SensitivityAnalysis

public static final class SensitivityAnalysis.TrialResult
extends Object
implements Serializable, Comparable<SensitivityAnalysis.TrialResult>

Single Monte Carlo trial result.

Contains the sampled parameter values and resulting output for one trial.

Version:

1.0

Author:

ESOL

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final String	bottleneck
private final boolean	converged
private final boolean	feasible
private final double	outputValue
private final Map<String,Double>	sampledParameters
private static final long	serialVersionUID
private final int	trialNumber

Constructor Summary

Constructors

Constructor	Description
TrialResult(int trialNumber, Map<String,Double> sampledParameters, double outputValue, String bottleneck, boolean feasible, boolean converged)	Creates a trial result.

Method Summary

Modifier and Type	Method	Description
int	compareTo(SensitivityAnalysis.TrialResult other)
String	getBottleneck()	Gets the bottleneck equipment name.
double	getOutputValue()	Gets the output value.
Map<String,Double>	getSampledParameters()	Gets the sampled parameter values.
int	getTrialNumber()	Gets the trial number.
boolean	isConverged()	Checks if the trial converged.
boolean	isFeasible()	Checks if the trial was feasible.

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

trialNumber

private final int trialNumber

sampledParameters

private final Map<String,Double> sampledParameters

outputValue

private final double outputValue

bottleneck

private final String bottleneck

feasible

private final boolean feasible

converged

private final boolean converged

Constructor Details

TrialResult

public TrialResult(int trialNumber,
 Map<String,Double> sampledParameters,
 double outputValue,
 String bottleneck,
 boolean feasible,
 boolean converged)

Creates a trial result.

Parameters:

trialNumber - trial index

sampledParameters - map of parameter name to sampled value

outputValue - output metric value

bottleneck - bottleneck equipment name (may be null)

feasible - true if solution was feasible

converged - true if simulation converged

Method Details

getTrialNumber

public int getTrialNumber()

Gets the trial number.

Returns:

trial number

getSampledParameters

public Map<String,Double> getSampledParameters()

Gets the sampled parameter values.

Returns:

map of parameter name to value

getOutputValue

public double getOutputValue()

Gets the output value.

Returns:

output metric value

getBottleneck

public String getBottleneck()

Gets the bottleneck equipment name.

Returns:

bottleneck name or null

isFeasible

public boolean isFeasible()

Checks if the trial was feasible.

Returns:

true if feasible

isConverged

public boolean isConverged()

Checks if the trial converged.

Returns:

true if converged

compareTo

public int compareTo(SensitivityAnalysis.TrialResult other)

Specified by:

compareTo in interface Comparable<SensitivityAnalysis.TrialResult>