Class MonteCarloSimulator.MonteCarloResult

java.lang.Object

neqsim.process.util.optimizer.MonteCarloSimulator.MonteCarloResult

All Implemented Interfaces:

Serializable

Enclosing class:

MonteCarloSimulator

public static class MonteCarloSimulator.MonteCarloResult
extends Object
implements Serializable

Results of a Monte Carlo simulation.

Version:

1.0

Author:

Even Solbraa

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final int	failCount
private final String	outputName
private final List<MonteCarloSimulator.UncertainParameter>	parameters
private static final long	serialVersionUID
private final double[]	sortedValues
private final int	successCount
private final List<MonteCarloSimulator.TornadoEntry>	tornado
private final int	totalIterations

Constructor Summary

Constructors

Constructor	Description
MonteCarloResult(String outputName, double[] sortedValues, int totalIterations, int successCount, int failCount, List<MonteCarloSimulator.TornadoEntry> tornado, List<MonteCarloSimulator.UncertainParameter> parameters)	Creates a Monte Carlo result.

Method Summary

Modifier and Type	Method	Description
double	getMean()	Gets the mean of all successful outputs.
double	getP10()	Gets the P10 percentile (10th percentile).
double	getP50()	Gets the P50 percentile (median).
double	getP90()	Gets the P90 percentile (90th percentile).
double	getPercentile(double percentile)	Gets a specific percentile value.
double	getProbabilityBelow(double threshold)	Gets the probability that the output is below a threshold.
double	getStdDev()	Gets the standard deviation of all successful outputs.
List<MonteCarloSimulator.TornadoEntry>	getTornado()	Gets the tornado sensitivity data, sorted by swing (descending).
String	toJson()	Converts results to JSON format.

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

outputName

private final String outputName

sortedValues

private final double[] sortedValues

totalIterations

private final int totalIterations

successCount

private final int successCount

failCount

private final int failCount

tornado

private final List<MonteCarloSimulator.TornadoEntry> tornado

parameters

private final List<MonteCarloSimulator.UncertainParameter> parameters

Constructor Details

MonteCarloResult

MonteCarloResult(String outputName,
 double[] sortedValues,
 int totalIterations,
 int successCount,
 int failCount,
 List<MonteCarloSimulator.TornadoEntry> tornado,
 List<MonteCarloSimulator.UncertainParameter> parameters)

Creates a Monte Carlo result.

Parameters:

outputName - name of the output variable

sortedValues - sorted array of successful output values

totalIterations - total iterations attempted

successCount - successful iterations

failCount - failed iterations

tornado - tornado sensitivity entries

parameters - input parameters

Method Details

getP10

public double getP10()

Gets the P10 percentile (10th percentile).

Returns:

P10 value

getP50

public double getP50()

Gets the P50 percentile (median).

Returns:

P50 value

getP90

public double getP90()

Gets the P90 percentile (90th percentile).

Returns:

P90 value

getMean

public double getMean()

Gets the mean of all successful outputs.

Returns:

mean value

getStdDev

public double getStdDev()

Gets the standard deviation of all successful outputs.

Returns:

standard deviation

getProbabilityBelow

public double getProbabilityBelow(double threshold)

Gets the probability that the output is below a threshold.

Parameters:

threshold - the threshold value

Returns:

probability (0 to 1)

getPercentile

public double getPercentile(double percentile)

Gets a specific percentile value.

Parameters:

percentile - the percentile (0-100)

Returns:

the percentile value

getTornado

public List<MonteCarloSimulator.TornadoEntry> getTornado()

Gets the tornado sensitivity data, sorted by swing (descending).

Returns:

list of tornado entries

toJson

public String toJson()

Converts results to JSON format.

Returns:

JSON representation