de.javagl.nd.arrays

Class Coordinates

java.lang.Object

de.javagl.nd.arrays.Coordinates

public class Coordinates
extends Object

Methods that provide streams over the coordinates of multidimensional arrays, based on a given array size.

Also see Indexing and Iteration Order

Method Summary

Modifier and Type	Method and Description
static java.util.stream.Stream<MutableIntTuple>	colexicographicalCoordinates(IntTuple arraySize) Returns a stream over the coordinates of an array with the given size, in colexicographical order.
static java.util.stream.Stream<MutableIntTuple>	coordinates(IntTuple arraySize) Returns a default stream over the coordinates of an array with the given size.
static java.util.stream.Stream<MutableIntTuple>	coordinates(Order order, IntTuple arraySize) Returns a stream over the coordinates of an array with the given size, using the given iteration Order.
static java.util.stream.Stream<MutableIntTuple>	lexicographicalCoordinates(IntTuple arraySize) Returns a stream over the coordinates of an array with the given size, in lexicographical order.

Methods inherited from class java.lang.Object

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

Method Detail

coordinates

public static java.util.stream.Stream<MutableIntTuple> coordinates(IntTuple arraySize)

Returns a default stream over the coordinates of an array with the given size. The iteration order of this streams is unspecified. No caller should make assumptions about the iteration order. This method is intended for situations where the same iteration order for multiple arrays is required.

Parameters:

arraySize - The array size

Returns:

The streams

Throws:

NullPointerException - If the given size is null

coordinates

public static java.util.stream.Stream<MutableIntTuple> coordinates(Order order,
                                                                   IntTuple arraySize)

Returns a stream over the coordinates of an array with the given size, using the given iteration Order. If the given Order is null, then an unspecified default order will be used.

Parameters:

order - The iteration Order

arraySize - The array size

Returns:

The streams

Throws:

NullPointerException - If the given size is null

lexicographicalCoordinates

public static java.util.stream.Stream<MutableIntTuple> lexicographicalCoordinates(IntTuple arraySize)

Returns a stream over the coordinates of an array with the given size, in lexicographical order.

Parameters:

arraySize - The array size

Returns:

The stream

Throws:

NullPointerException - If the given size is null

colexicographicalCoordinates

public static java.util.stream.Stream<MutableIntTuple> colexicographicalCoordinates(IntTuple arraySize)

Returns a stream over the coordinates of an array with the given size, in colexicographical order.

Parameters:

arraySize - The array size

Returns:

The stream

Throws:

NullPointerException - If the given size is null