de.javagl.nd.arrays.i

Interface IntArrayND

All Superinterfaces:

ArrayND

All Known Subinterfaces:

MutableIntArrayND

public interface IntArrayND
extends ArrayND

Interface for multidimensional arrays of int values.

Method Summary

Modifier and Type	Method and Description
int	get(IntTuple indices) Returns the value at the given position.
default java.util.stream.IntStream	stream() Returns a sequential IntStream with this array as its source.
default IntArrayND	subArray(IntTuple fromIndices, IntTuple toIndices) Returns a view on a portion of this array.

Methods inherited from interface de.javagl.nd.arrays.ArrayND

coordinates, getPreferredIterationOrder, getSize, getTotalSize

Method Detail

get

int get(IntTuple indices)

Returns the value at the given position.

This method may throw an IndexOutOfBoundsException if the indices are not within the size of this array, but explicit bounds checking along each dimension is not guaranteed.

Parameters:

indices - The indices describing the position

Returns:

The value at the given position.

Throws:

NullPointerException - if the given indices are null

IllegalArgumentException - If the given indices do not have the same size as the size of this array.

IndexOutOfBoundsException - May be thrown if the indices are not valid. That is, if fromIndex < 0 or toIndex > size or fromIndex > toIndex for any dimension. But explicit bounds checking is not guaranteed.

subArray

default IntArrayND subArray(IntTuple fromIndices,
                            IntTuple toIndices)

Description copied from interface: ArrayND

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

Specified by:

subArray in interface ArrayND

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

stream

default java.util.stream.IntStream stream()

Returns a sequential IntStream with this array as its source.

Returns:

The stream