gov.usgs.earthquake.nshmp.data

Interface DataArray

All Superinterfaces:

Iterable<Double>

All Known Implementing Classes:

RegularDataArray

public interface DataArray
extends Iterable<Double>

An interface representing an immutable wrapper around an array of primitive double values. Use factory constructors or builders to create instances of this class.

In addition to iterator() returning the double primitive specialization PrimitiveIterator.OfDouble implementations of this interface provide streaming support via stream() and parallelStream(), both of which return the double primitive specialization, DoubleStream. Note that traditional iteration will incur additional autoboxing overhead.

Author:

Brandon Clayton, Peter Powers

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DataArray.Builder A DataArray builder.

Method Summary

Modifier and Type	Method and Description
static DataArray.Builder	builderWithData(double... data) Return a new DataArray Builder initialized with data.
static DataArray.Builder	builderWithData(Iterable<Double> data) Return a new DataArray Builder initialized with Iterable<Double>.
static DataArray.Builder	builderWithSize(int size) Return a new DataArray Builder initialized to size.
static DataArray	copyOf(double... data) Create a new DataArray from the supplied data.
static DataArray	copyOf(Iterable<Double> data) Create a new DataArray from an Iterable<Double>.
double	get(int index) Return a double at index.
default PrimitiveIterator.OfDouble	iterator() Return a double iterator.
default DoubleStream	parallelStream() Return a parallel DoubleStream of the DataArray.
int	size() Return the number of elements in DataArray.
Spliterator.OfDouble	spliterator() Returns a Spliterator.ofDouble Spliterator.
default DoubleStream	stream() Return a sequential DoubleStream of the DataArray.
double[]	toArray() Returns a new, mutable copy of the DataArray's values as a primitive double[].

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

iterator

default PrimitiveIterator.OfDouble iterator()

Return a double iterator.

Specified by:

iterator in interface Iterable<Double>

spliterator

Spliterator.OfDouble spliterator()

Returns a Spliterator.ofDouble Spliterator.

Specified by:

spliterator in interface Iterable<Double>

get

double get(int index)

Return a double at index.

Parameters:

index - of the value to get

Returns:

double at position index

size

int size()

Return the number of elements in DataArray.

Returns:

int The size of DataArray

toArray

double[] toArray()

Returns a new, mutable copy of the DataArray's values as a primitive double[].

Returns:

double[]

parallelStream

default DoubleStream parallelStream()

Return a parallel DoubleStream of the DataArray.

Returns:

parallel DoubleStream

stream

default DoubleStream stream()

Return a sequential DoubleStream of the DataArray.

Returns:

DoubleStream

copyOf

static DataArray copyOf(double... data)

Create a new DataArray from the supplied data.

Parameters:

data - to copy

Returns:

New DataArray

copyOf

static DataArray copyOf(Iterable<Double> data)

Create a new DataArray from an Iterable<Double>.

Parameters:

data - to copy

Returns:

new DataArray

builderWithData

static DataArray.Builder builderWithData(double... data)

Return a new DataArray Builder initialized with data.

Parameters:

data - to copy

Returns:

new Builder

builderWithData

static DataArray.Builder builderWithData(Iterable<Double> data)

Return a new DataArray Builder initialized with Iterable<Double>.

Parameters:

data - to copy

Returns:

new Builder.

builderWithSize

static DataArray.Builder builderWithSize(int size)

Return a new DataArray Builder initialized to size.

Parameters:

size - of the backing array

Returns:

new Builder