Class PredictionResult.PredictedValue

java.lang.Object

neqsim.process.advisory.PredictionResult.PredictedValue

All Implemented Interfaces:

Serializable

Enclosing class:

PredictionResult

public static class PredictionResult.PredictedValue
extends Object
implements Serializable

A predicted value with uncertainty bounds.

Version:

1.0

Author:

ESOL

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final double	confidence
private final double	lower95
private final double	mean
private static final long	serialVersionUID
private final double	standardDeviation
private final String	unit
private final double	upper95

Constructor Summary

Constructors

Constructor	Description
PredictedValue(double mean, double lower95, double upper95, String unit, double confidence)	Creates a predicted value with explicit bounds.
PredictedValue(double mean, double standardDeviation, String unit)	Creates a predicted value with uncertainty.

Method Summary

Modifier and Type	Method	Description
static PredictionResult.PredictedValue	deterministic(double value, String unit)	Creates a deterministic predicted value (no uncertainty).
double	getConfidence()
double	getLower95()
double	getMean()
double	getStandardDeviation()
String	getUnit()
double	getUpper95()
String	toString()

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

mean

private final double mean

standardDeviation

private final double standardDeviation

lower95

private final double lower95

upper95

private final double upper95

unit

private final String unit

confidence

private final double confidence

Constructor Details

PredictedValue

public PredictedValue(double mean,
 double standardDeviation,
 String unit)

Creates a predicted value with uncertainty.

Parameters:

mean - expected value

standardDeviation - uncertainty (standard deviation)

unit - engineering unit

PredictedValue

public PredictedValue(double mean,
 double lower95,
 double upper95,
 String unit,
 double confidence)

Creates a predicted value with explicit bounds.

Parameters:

mean - expected value

lower95 - lower 95% confidence bound

upper95 - upper 95% confidence bound

unit - engineering unit

confidence - overall confidence (0-1)

Method Details

deterministic

public static PredictionResult.PredictedValue deterministic(double value,
 String unit)

Creates a deterministic predicted value (no uncertainty).

Parameters:

value - the predicted value

unit - engineering unit

Returns:

a PredictedValue with zero uncertainty

getMean

public double getMean()

getStandardDeviation

public double getStandardDeviation()

getLower95

public double getLower95()

getUpper95

public double getUpper95()

getUnit

public String getUnit()

getConfidence

public double getConfidence()

toString

public String toString()

Overrides:

toString in class Object