gov.usgs.earthquake.nshmp.data

Class IntervalTable.Builder

java.lang.Object

gov.usgs.earthquake.nshmp.data.IntervalTable.Builder

Enclosing interface:

IntervalTable

public static final class IntervalTable.Builder
extends Object

A builder of immutable IntervalTables.

Rows and columns must be specified before any data can be added. Note that any supplied max values may not correspond to the final upper edge of the uppermost bins if max - min is not evenly divisible by Δ .

Constructor Summary

Constructors

Constructor and Description
Builder() Create a new builder.

Method Summary

Modifier and Type	Method and Description
IntervalTable.Builder	add(double row, double[] values) Add to the values in the specified row.
IntervalTable.Builder	add(double row, double column, double value) Add to the existing value at the specified row and column.
IntervalTable.Builder	add(double row, double column, double[] values) Add to the values in the specified row starting at the specified column.
IntervalTable.Builder	add(double row, double column, List<Double> values) Add to the values in the specified row starting at the specified column.
IntervalTable.Builder	add(double row, List<Double> values) Add to the values in the specified row.
IntervalTable.Builder	add(double row, XySequence sequence) Add the y-values of the supplied sequence to the values in the specified row.
IntervalTable.Builder	add(IntervalTable table) Add the values in the supplied table to this builder.
IntervalTable.Builder	add(int row, int column, double value) Add to the existing value at the specified row and column indices.
IntervalTable	build() Return a newly-created, immutable, 2-dimensional data container populated with the contents of this Builder.
IntervalTable	build(IntervalTable.Loader loader) Return a newly-created, immutable, 2-dimensional data container populated with values computed by the supplied loader.
int	columnIndex(double column) Return the index of the column that would contain the supplied value.
IntervalTable.Builder	columns(double min, double max, double Δ) Define the table column intervals.
static IntervalTable.Builder	copyOf(IntervalTable table) Create a new builder with the structure and content identical to that of the supplied table.
static IntervalTable.Builder	fromModel(IntervalTable model) Create a new builder with a structure identical to that of the supplied model.
IntervalTable.Builder	multiply(double scale) Multiply (scale) all values in this builder.
int	rowIndex(double row) Return the index of the row that would contain the supplied value.
IntervalTable.Builder	rows(double min, double max, double Δ) Define the table row intervals.
IntervalTable.Builder	set(double row, double column, double value) Set the value at the specified row and column.
IntervalTable.Builder	set(int row, int column, double value) Set the value at the specified row and column indices.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Create a new builder.

Method Detail

copyOf

public static IntervalTable.Builder copyOf(IntervalTable table)

Create a new builder with the structure and content identical to that of the supplied table.

Parameters:

table - to copy

fromModel

public static IntervalTable.Builder fromModel(IntervalTable model)

Create a new builder with a structure identical to that of the supplied model.

Parameters:

model - data table

rows

public IntervalTable.Builder rows(double min,
                                  double max,
                                  double Δ)

Define the table row intervals.

Parameters:

min - lower edge of lowermost row bin

max - upper edge of uppermost row bin

Δ - bin discretization

columns

public IntervalTable.Builder columns(double min,
                                     double max,
                                     double Δ)

Define the table column intervals.

Parameters:

min - lower edge of lowermost column bin

max - upper edge of uppermost column bin

Δ - bin discretization

rowIndex

public int rowIndex(double row)

Return the index of the row that would contain the supplied value.

Parameters:

row - value

columnIndex

public int columnIndex(double column)

Return the index of the column that would contain the supplied value.

Parameters:

column - value

set

public IntervalTable.Builder set(double row,
                                 double column,
                                 double value)

Set the value at the specified row and column. Be careful not to confuse this with set(int, int, double).

Parameters:

row - key

column - key

value - to set

set

public IntervalTable.Builder set(int row,
                                 int column,
                                 double value)

Set the value at the specified row and column indices. Be careful not to confuse this with set(double, double, double).

Parameters:

row - index

column - index

value - to set

add

public IntervalTable.Builder add(double row,
                                 double column,
                                 double value)

Add to the existing value at the specified row and column. Be careful not to confuse this with add(int, int, double).

Parameters:

row - key

column - key

value - to add

add

public IntervalTable.Builder add(int row,
                                 int column,
                                 double value)

Add to the existing value at the specified row and column indices. Be careful not to confuse this with add(double, double, double) .

Parameters:

row - index

column - index

value - to add

add

public IntervalTable.Builder add(double row,
                                 double[] values)

Add to the values in the specified row.

Parameters:

row - key

values - to add

Throws:

IndexOutOfBoundsException - if values overrun row

add

public IntervalTable.Builder add(double row,
                                 List<Double> values)

Add to the values in the specified row.

Parameters:

row - key

values - to add

Throws:

IndexOutOfBoundsException - if values overrun row

add

public IntervalTable.Builder add(double row,
                                 XySequence sequence)

Add the y-values of the supplied sequence to the values in the specified row.

Parameters:

row - key

sequence - to add

Throws:

IndexOutOfBoundsException - if values overrun row

add

public IntervalTable.Builder add(double row,
                                 double column,
                                 double[] values)

Add to the values in the specified row starting at the specified column.

Parameters:

row - key

column - key from which to start adding values

values - to add

Throws:

IndexOutOfBoundsException - if values overrun row

add

public IntervalTable.Builder add(double row,
                                 double column,
                                 List<Double> values)

Add to the values in the specified row starting at the specified column.

Parameters:

row - key

column - key from which to start adding values

values - to add

Throws:

IndexOutOfBoundsException - if values will overrun row

add

public IntervalTable.Builder add(IntervalTable table)

Add the values in the supplied table to this builder. This operation is very efficient if this builder and the supplied table are sourced from the same model.

Parameters:

table - to add

Throws:

IllegalArgumentException - if the rows and columns of the supplied table do not match those of this table

See Also:

fromModel(IntervalTable)

multiply

public IntervalTable.Builder multiply(double scale)

Multiply (scale) all values in this builder.

Parameters:

scale - factor

build

public IntervalTable build(IntervalTable.Loader loader)

Return a newly-created, immutable, 2-dimensional data container populated with values computed by the supplied loader. Calling this method will overwrite any values already supplied via set* or add* methods.

Parameters:

loader - that will compute values

build

public IntervalTable build()

Return a newly-created, immutable, 2-dimensional data container populated with the contents of this Builder.