Package com.opengamma.strata.math.impl.statistics.descriptive

Class QuantileResult

java.lang.Object

com.opengamma.strata.math.impl.statistics.descriptive.QuantileResult

All Implemented Interfaces:

Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class QuantileResult
extends Object
implements org.joda.beans.ImmutableBean, Serializable

Object describing the result from a QuantileCalculationMethod.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QuantileResult.Meta	The meta-bean for QuantileResult.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int[]	getIndices()	Gets the indices.
double	getValue()	Gets the quantile value.
DoubleArray	getWeights()	Gets the weights.
int	hashCode()
static QuantileResult.Meta	meta()	The meta-bean for QuantileResult.
QuantileResult.Meta	metaBean()
static QuantileResult	of(double value, int[] indices, DoubleArray weights)	Creates an QuantileResult from the value, the indices and the weights.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Method Detail

of

public static QuantileResult of(double value,
                                int[] indices,
                                DoubleArray weights)

Creates an QuantileResult from the value, the indices and the weights.

The amounts must be of the correct type, one pay and one receive. The currencies of the payments must differ.

Parameters:

value - the quantile value

indices - the indices of the samples used in the quantile computation

weights - the weights of the samples used in the quantile computation

Returns:

the quantile result

meta

public static QuantileResult.Meta meta()

The meta-bean for QuantileResult.

Returns:

the meta-bean, not null

metaBean

public QuantileResult.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getValue

public double getValue()

Gets the quantile value.

Returns:

the value of the property

getIndices

public int[] getIndices()

Gets the indices.

Returns:

the value of the property

getWeights

public DoubleArray getWeights()

Gets the weights.

Returns:

the value of the property, not null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object