gov.usgs.earthquake.nshmp.data

Interface IntervalTable

public interface IntervalTable

A 2-dimensional table of immutable, double-valued data that is arranged according to increasing and uniformly spaced double-valued keys. Interval tables are used to represent binned data, and so while row and column 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 IntervalTable, use a IntervalTable.Builder.

Internally, an IntervalTable is backed by a double[][] where a 'row' maps to the 1st dimension and a 'column' the 2nd.

Note that interval tables 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, IntervalArray, IntervalVolume

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IntervalTable.Builder A builder of immutable IntervalTables.
static interface	IntervalTable.Loader A supplier of values with which to fill a IntervalTable.

Method Summary

Modifier and Type	Method and Description
IntervalArray	collapse() Return a new IntervalArray created by summing the columns of this table.
double	columnMax() Return the upper edge of the uppermost column bin.
double	columnMin() Return the lower edge of the lowermost column bin.
List<Double>	columns() Return an immutable list view of the column keys (bin centers).
double	columnΔ() Return the column bin discretization.
double	get(double rowValue, double columnValue) Return the value of the bin that maps to the supplied row and column values.
double	get(int rowIndex, int columnIndex) Return the value of the bin that maps to the supplied row and column indices.
int[]	maxIndex() Return the indices of the bin with largest value in the form [rowIndex, columnIndex].
int[]	minIndex() Return the indices of the bin with smallest value in the form [rowIndex, columnIndex].
XySequence	row(double rowValue) Return an immutable view of the values that map to the supplied row value.
XySequence	row(int rowIndex) Return an immutable view of the values that map to the supplied row index.
double	rowMax() Return the upper edge of the uppermost row bin.
double	rowMin() Return the lower edge of the lowermost row bin.
List<Double>	rows() Return an immutable list view of the row keys (bin centers).
double	rowΔ() Return the row bin discretization.

Method Detail

get

double get(double rowValue,
           double columnValue)

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

Parameters:

rowValue - of bin to retrieve

columnValue - of bin to retrieve

Throws:

IndexOutOfBoundsException - if either value is out of range

get

double get(int rowIndex,
           int columnIndex)

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

Parameters:

rowIndex - of bin to retrieve

columnIndex - of bin to retrieve

Throws:

IndexOutOfBoundsException - if either index is out of range

row

XySequence row(double rowValue)

Return an immutable view of the values that map to the supplied row value. Do not confuse with row(int) retrieval by index.

Parameters:

rowValue - of bin to retrieve

row

XySequence row(int rowIndex)

Return an immutable view of the values that map to the supplied row index. Do not confuse with row(double) retrieval by value.

Parameters:

rowIndex - of bin to retrieve

rowMin

double rowMin()

Return the lower edge of the lowermost row bin.

rowMax

double rowMax()

Return the upper edge of the uppermost row bin.

rowΔ

double rowΔ()

Return the row bin discretization.

rows

List<Double> rows()

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

columnMin

double columnMin()

Return the lower edge of the lowermost column bin.

columnMax

double columnMax()

Return the upper edge of the uppermost column bin.

columnΔ

double columnΔ()

Return the column bin discretization.

columns

List<Double> columns()

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

collapse

IntervalArray collapse()

Return a new IntervalArray created by summing the columns of this table.

minIndex

int[] minIndex()

Return the indices of the bin with smallest value in the form [rowIndex, columnIndex].

maxIndex

int[] maxIndex()

Return the indices of the bin with largest value in the form [rowIndex, columnIndex].