de.javagl.nd.arrays

Interface ArrayND

All Known Subinterfaces:

DoubleArrayND, IntArrayND, LongArrayND, MutableDoubleArrayND, MutableIntArrayND, MutableLongArrayND

All Known Implementing Classes:

AbstractArrayND

public interface ArrayND

Interface describing a multidimensional array

Method Summary

Modifier and Type	Method and Description
default java.util.stream.Stream<? extends MutableIntTuple>	coordinates() Returns a stream of the coordinates of this array.
Order	getPreferredIterationOrder() Returns the preferred iteration Order of this array, or null if this array does not have any preferred iteration order.
IntTuple	getSize() Returns the size of the array.
int	getTotalSize() Returns the total size of this array.
ArrayND	subArray(IntTuple fromIndices, IntTuple toIndices) Returns a view on a portion of this array.

Method Detail

getSize

IntTuple getSize()

Returns the size of the array.

Returns:

The size of the array.

getTotalSize

int getTotalSize()

Returns the total size of this array. This is the product of the size along all dimensions.

Returns:

The total size

getPreferredIterationOrder

Order getPreferredIterationOrder()

Returns the preferred iteration Order of this array, or null if this array does not have any preferred iteration order.

Returns:

The preferred iteration Order

coordinates

default java.util.stream.Stream<? extends MutableIntTuple> coordinates()

Returns a stream of the coordinates of this array. This stream will return all valid coordinates inside this array, in its preferred iteration order. (For example, for a 2D array, it may return the coordinates that either represent a row-major, or a column-major iteration order).

To obtain a stream over the coordinates of several arrays in a consistent order, Coordinates.coordinates(IntTuple) may be used, passing in the size of the array.

To obtain a stream over the coordinates in one particular order, Coordinates.lexicographicalCoordinates(IntTuple) or Coordinates.colexicographicalCoordinates(IntTuple) may be used.

Also see Indexing and Iteration Order

Returns:

The stream over the coordinates.

subArray

ArrayND subArray(IntTuple fromIndices,
                 IntTuple toIndices)

Returns a view on a portion of this array. Changes in this array will be visible in the returned array.

Parameters:

fromIndices - The start indices of the sub-array along each dimension (inclusive)

toIndices - The end indices of the sub-array along each dimension (exclusive)

Returns:

The sub-array

Throws:

NullPointerException - if any of the given indices are null

IllegalArgumentException - If the indices are not valid. This is the case when the size of the start- or end indices is different than the size of the getSize() of this array, or when fromIndex < 0 or toIndex > size(i) or fromIndex > toIndex for any dimension.