org.flexiblepower.ral.values

Class UncertainMeasure<Q extends javax.measure.quantity.Quantity>

java.lang.Object

org.flexiblepower.ral.values.UncertainMeasure<Q>

Type Parameters:

Q - Quantity of measurement, see Commodity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<javax.measure.Measurable<Q>>, javax.measure.Measurable<Q>

public class UncertainMeasure<Q extends javax.measure.quantity.Quantity>
extends java.lang.Object
implements java.io.Serializable, javax.measure.Measurable<Q>

This class is being used to express uncertainty about a value. It does not prescribe a particular distribution, such as a normal distribution. Instead UncertainMeasure provides the mean value as well as the ranges in which 68 and 95 percent of the values fall. For both ranges a lower and upper bound is given. This flexible solution also allows the expression of asymmetric distributions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UncertainMeasure(double the95pprLowerBound, double the68pprLowerBound, double mean, double the68pprUpperBound, double the95pprUpperBound, javax.measure.unit.Unit<Q> unit)
UncertainMeasure(double mean, double standardDeviation, javax.measure.unit.Unit<Q> unit)
UncertainMeasure(double value, javax.measure.unit.Unit<Q> unit)

Method Summary

Methods

Modifier and Type	Method and Description
javax.measure.Measurable<Q>	add(javax.measure.Measurable<Q> other)
int	compareTo(javax.measure.Measurable<Q> other)
double	doubleValue(javax.measure.unit.Unit<Q> unit)
boolean	equals(java.lang.Object obj)
javax.measure.Measure<java.lang.Double,Q>	get68PPRLowerBound()
javax.measure.Measure<java.lang.Double,Q>	get68PPRUpperBound()
javax.measure.Measure<java.lang.Double,Q>	get95PPRLowerBound()
javax.measure.Measure<java.lang.Double,Q>	get95PPRUpperBound()
javax.measure.Measure<java.lang.Double,Q>	getMean()
javax.measure.Measure<java.lang.Double,Q>	getStandardDeviation() Gets the standard deviaton.
javax.measure.unit.Unit<Q>	getUnit()
int	hashCode()
boolean	isIn68PPR(javax.measure.Measurable<Q> measure)
boolean	isIn95PPR(javax.measure.Measurable<Q> measure)
long	longValue(javax.measure.unit.Unit<Q> unit)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UncertainMeasure

public UncertainMeasure(double value,
                javax.measure.unit.Unit<Q> unit)

UncertainMeasure

public UncertainMeasure(double mean,
                double standardDeviation,
                javax.measure.unit.Unit<Q> unit)

UncertainMeasure

public UncertainMeasure(double the95pprLowerBound,
                double the68pprLowerBound,
                double mean,
                double the68pprUpperBound,
                double the95pprUpperBound,
                javax.measure.unit.Unit<Q> unit)

Method Detail

getMean

public javax.measure.Measure<java.lang.Double,Q> getMean()

getUnit

public javax.measure.unit.Unit<Q> getUnit()

getStandardDeviation

public javax.measure.Measure<java.lang.Double,Q> getStandardDeviation()

Gets the standard deviaton. WARNING: ASSUMES NORMAL DISTRIBUTION

Returns:

Standard deviation of this probability distribution

get68PPRLowerBound

public javax.measure.Measure<java.lang.Double,Q> get68PPRLowerBound()

get68PPRUpperBound

public javax.measure.Measure<java.lang.Double,Q> get68PPRUpperBound()

isIn68PPR

public boolean isIn68PPR(javax.measure.Measurable<Q> measure)

get95PPRLowerBound

public javax.measure.Measure<java.lang.Double,Q> get95PPRLowerBound()

get95PPRUpperBound

public javax.measure.Measure<java.lang.Double,Q> get95PPRUpperBound()

isIn95PPR

public boolean isIn95PPR(javax.measure.Measurable<Q> measure)

compareTo

public int compareTo(javax.measure.Measurable<Q> other)

Specified by:

compareTo in interface java.lang.Comparable<javax.measure.Measurable<Q extends javax.measure.quantity.Quantity>>

doubleValue

public double doubleValue(javax.measure.unit.Unit<Q> unit)

Specified by:

doubleValue in interface javax.measure.Measurable<Q extends javax.measure.quantity.Quantity>

longValue

public long longValue(javax.measure.unit.Unit<Q> unit)
               throws java.lang.ArithmeticException

Specified by:

longValue in interface javax.measure.Measurable<Q extends javax.measure.quantity.Quantity>

Throws:

java.lang.ArithmeticException

add

public javax.measure.Measurable<Q> add(javax.measure.Measurable<Q> other)

Specified by:

add in interface javax.measure.Measurable<Q extends javax.measure.quantity.Quantity>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object