IntervalArray.Builder (nshmp-haz)

java.lang.Object
- gov.usgs.earthquake.nshmp.data.IntervalArray.Builder

Enclosing interface:

IntervalArray
```
public static final class IntervalArray.Builder
extends Object
```
A builder of immutable IntervalArrays.
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.

Constructors
Constructor and Description
`Builder()` Create a new builder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IntervalArray.Builder`	`add(double[] values)` Add to the array being built.
`IntervalArray.Builder`	`add(double row, double value)` Add to the existing value at the specified row.
`IntervalArray.Builder`	`add(double row, double[] values)` Add to the array being built starting at the specified row.
`IntervalArray.Builder`	`add(double row, List<Double> values)` Add to the array being built starting at the specified row.
`IntervalArray.Builder`	`add(int row, double value)` Add to the existing value at the specified row.
`IntervalArray.Builder`	`add(IntervalArray array)` Add the values in the supplied array to this builder.
`IntervalArray.Builder`	`add(List<Double> values)` Add to the array being built.
`IntervalArray.Builder`	`add(XySequence sequence)` Add the y-values of the supplied sequence to the array being built.
`IntervalArray.Builder`	`addEach(XySequence sequence)` Add each value-pair of the supplied sequence to the appropriate interval.
`IntervalArray`	`build()` Return a newly-created, immutable, interval data array populated with the contents of this `Builder`.
`IntervalArray`	`build(IntervalArray.Loader loader)` Return a newly-created, immutable, 2-dimensional data container populated with values computed by the supplied loader.
`static IntervalArray.Builder`	`copyOf(IntervalArray array)` Create a new builder with the structure and content identical to that of the supplied array.
`static IntervalArray.Builder`	`fromModel(IntervalArray model)` Create a new builder with a structure identical to that of the supplied model.
`IntervalArray.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.
`IntervalArray.Builder`	`set(double row, double value)` Set the value at the specified row.
`IntervalArray.Builder`	`set(int row, double value)` Set the value at the specified row.
`static IntervalArray.Builder`	`withRows(double min, double max, double Δ)` Define the array intervals.

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 IntervalArray.Builder copyOf(IntervalArray array)
```
    Create a new builder with the structure and content identical to that of the supplied array.
    
    Parameters:
    
    array - to copy
  - fromModel
```
public static IntervalArray.Builder fromModel(IntervalArray model)
```
    Create a new builder with a structure identical to that of the supplied model.
    
    Parameters:
    
    model - interval array
  - withRows
```
public static IntervalArray.Builder withRows(double min,
                                             double max,
                                             double Δ)
```
    Define the array intervals.
    
    Parameters:
    
    min - lower edge of lowermost row bin
    
    max - upper edge of uppermost row bin
    
    Δ - bin discretization
  - rowIndex
```
public int rowIndex(double row)
```
    Return the index of the row that would contain the supplied value.
    
    Parameters:
    
    row - value
  - set
```
public IntervalArray.Builder set(double row,
                                 double value)
```
    Set the value at the specified row. Be careful not to confuse this with set(int, double).
    
    Parameters:
    
    row - key
    
    value - to set
  - set
```
public IntervalArray.Builder set(int row,
                                 double value)
```
    Set the value at the specified row. Be careful not to confuse this with set(double, double).
    
    Parameters:
    
    row - index
    
    value - to set
  - add
```
public IntervalArray.Builder add(double row,
                                 double value)
```
    Add to the existing value at the specified row. Be careful not to confuse this with add(int, double).
    
    Parameters:
    
    row - key
    
    value - to add
  - add
```
public IntervalArray.Builder add(int row,
                                 double value)
```
    Add to the existing value at the specified row. Be careful not to confuse this with add(double, double).
    
    Parameters:
    
    row - index
    
    value - to add
  - add
```
public IntervalArray.Builder add(double[] values)
```
    Add to the array being built.
    
    Parameters:
    
    values - to add
    
    Throws:
    
    IndexOutOfBoundsException - if values overrun array
  - add
```
public IntervalArray.Builder add(List<Double> values)
```
    Add to the array being built.
    
    Parameters:
    
    values - to add
    
    Throws:
    
    IndexOutOfBoundsException - if values overrun array
  - add
```
public IntervalArray.Builder add(XySequence sequence)
```
    Add the y-values of the supplied sequence to the array being built.
    
    Parameters:
    
    sequence - to add
    
    Throws:
    
    IndexOutOfBoundsException - if values overrun array
  - add
```
public IntervalArray.Builder add(double row,
                                 double[] values)
```
    Add to the array being built starting at the specified row.
    
    Parameters:
    
    row - key from which to start adding values
    
    values - to add
    
    Throws:
    
    IndexOutOfBoundsException - if values overrun array
  - add
```
public IntervalArray.Builder add(double row,
                                 List<Double> values)
```
    Add to the array being built starting at the specified row.
    
    Parameters:
    
    row - key from which to start adding values
    
    values - to add
    
    Throws:
    
    IndexOutOfBoundsException - if values will overrun array
  - add
```
public IntervalArray.Builder add(IntervalArray array)
```
    Add the values in the supplied array to this builder. This operation is very efficient if this builder and the supplied array are sourced from the same model.
    
    Parameters:
    
    array - to add
    
    Throws:
    
    IllegalArgumentException - if the rows of the supplied array do not match those of this array
    
    See Also:
    
    fromModel(IntervalArray)
  - addEach
```
public IntervalArray.Builder addEach(XySequence sequence)
```
    Add each value-pair of the supplied sequence to the appropriate interval.
    
    Parameters:
    
    sequence - to add
  - multiply
```
public IntervalArray.Builder multiply(double scale)
```
    Multiply (scale) all values in this builder.
    
    Parameters:
    
    scale - factor
  - build
```
public IntervalArray build(IntervalArray.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 IntervalArray build()
```
    Return a newly-created, immutable, interval data array populated with the contents of this Builder.

Class IntervalArray.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

copyOf

fromModel

withRows

rowIndex

set

set

add

add

add

add

add

add

add

add

addEach

multiply

build

build