gov.usgs.earthquake.nshmp.data

Interface IntervalArray

public interface IntervalArray

An array of immutable, double-valued data that is arranged according to increasing and uniformly spaced double-valued keys. Interval arrays are used to represent binned data, and so while row keys are bin centers, indexing is managed internally using bin edges. This simplifies issues related to rounding/precision errors that occur when indexing according to explicit double values.

To create an instance of an IntervalArray, use a IntervalArray.Builder.

Internally, an IntervalArray is backed by a double[] where a 'row' maps to an index in the backing array.

Note that interval arrays are not intended for use with very high precision data and keys are currently limited to a precision of 4 decimal places. This may change in the future.

Author:

Peter Powers

See Also:

IntervalData, IntervalTable, IntervalVolume

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IntervalArray.Builder A builder of immutable IntervalArrays.
static interface	IntervalArray.Loader A supplier of values with which to fill an IntervalArray.

Method Summary

Modifier and Type	Method and Description
double	get(double rowValue) Return the value of the bin that maps to the supplied row value.
double	get(int rowIndex) Return the value of the bin that maps to the supplied row index.
int	maxIndex() Return the index of the bin with largest value.
int	minIndex() Return the index of the bin with smallest value.
double	rowMax() Return the upper edge of the uppermost bin.
double	rowMin() Return the lower edge of the lowermost bin.
List<Double>	rows() Return an immutable list view of the row keys (bin centers).
double	rowΔ() Return the row bin discretization.
double	sum() Return the sum of the values in this array.
XySequence	values() Return an immutable view of this as an XySequence.

Method Detail

get

double get(double rowValue)

Return the value of the bin that maps to the supplied row value. Do not confuse this method with get(int) by row index.

Parameters:

rowValue - of bin to retrieve

Throws:

IndexOutOfBoundsException - if value is out of range

get

double get(int rowIndex)

Return the value of the bin that maps to the supplied row index. Do not confuse this method with get(double) by row value.

Parameters:

rowIndex - of bin to retrieve

Throws:

IndexOutOfBoundsException - if index is out of range

values

XySequence values()

Return an immutable view of this as an XySequence.

rowMin

double rowMin()

Return the lower edge of the lowermost bin.

rowMax

double rowMax()

Return the upper edge of the uppermost bin.

rowΔ

double rowΔ()

Return the row bin discretization.

rows

List<Double> rows()

Return an immutable list view of the row keys (bin centers).

sum

double sum()

Return the sum of the values in this array.

minIndex

int minIndex()

Return the index of the bin with smallest value.

maxIndex

int maxIndex()

Return the index of the bin with largest value.