gov.usgs.earthquake.nshmp.data

Class IntervalData

java.lang.Object

gov.usgs.earthquake.nshmp.data.IntervalData

public final class IntervalData
extends Object

Static utilities for working with and concrete implementations of 1-, 2- and 3-dimensional interval data containers.

Author:

Peter Powers

See Also:

IntervalArray, IntervalTable, IntervalVolume

Constructor Summary

Constructors

Constructor and Description
IntervalData()

Method Summary

Modifier and Type	Method and Description
static int	indexOf(double min, double delta, double value, int size) Compute an index from a minimum value, a value and an interval.
static double[]	keys(double min, double max, double Δ) Create key values for use in an IntervalArray, IntervalTable or IntervalVolume.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntervalData

public IntervalData()

Method Detail

keys

public static double[] keys(double min,
                            double max,
                            double Δ)

Create key values for use in an IntervalArray, IntervalTable or IntervalVolume. These classes call this method directly when initializing their backing arrays. It is exposed for convenience as there are circumstances where a reference to the row or column keys is helpful to have when working with the builders for these classes. Internally, this method calls Data.buildCleanSequence(double, double, double, boolean, int) with a precision value of 4 decimal places. This may change in the future.

Example: keys(5.0, 8.0, 1.0) returns [5.5, 6.5, 7.5]

Parameters:

min - lower edge of lowermost bin

max - upper edge of uppermost bin

Δ - bin width

indexOf

public static int indexOf(double min,
                          double delta,
                          double value,
                          int size)

Compute an index from a minimum value, a value and an interval.

Parameters:

min - value

delta - interval (i.e. bin width)

value - for which to compute index

size - of array or collection for which index is to be used

Throws:

IndexOutOfBoundsException - if the index of value falls outside the allowed index range of [0, size-1].

IllegalArgumentException - if size is negative