de.javagl.nd.arrays

Class Indexers

java.lang.Object

de.javagl.nd.arrays.Indexers

public class Indexers
extends Object

Methods to create functions that map IntTuple instances to 1-dimensional (array) indices.

Also see Indexing and Iteration Order

Method Summary

Modifier and Type	Method and Description
static java.util.function.ToIntFunction<IntTuple>	colexicographicalIndexer(IntTuple size) Creates a function that maps multidimensional indices to 1D indices.
static java.util.function.ToIntFunction<IntTuple>	indexer(Order order, IntTuple size) Creates a function that maps multidimensional indices to 1D indices.
static java.util.function.ToIntFunction<IntTuple>	lexicographicalIndexer(IntTuple size) Creates a function that maps multidimensional indices to 1D indices.

Methods inherited from class java.lang.Object

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

Method Detail

indexer

public static java.util.function.ToIntFunction<IntTuple> indexer(Order order,
                                                                 IntTuple size)

Creates a function that maps multidimensional indices to 1D indices. The function will create consecutive 1D indices for indices that are given in the given Order. If the given Order is null, then an unspecified default order will be used.

Parameters:

order - The order for the indexing

size - The size of the array to index

Returns:

The indexer function

Throws:

NullPointerException - If the given size is null.

lexicographicalIndexer

public static java.util.function.ToIntFunction<IntTuple> lexicographicalIndexer(IntTuple size)

Creates a function that maps multidimensional indices to 1D indices. The function will create consecutive 1D indices for indices that are given in lexicographical order.

Parameters:

size - The size of the array to index

Returns:

The indexer function

Throws:

NullPointerException - If the given size is null.

colexicographicalIndexer

public static java.util.function.ToIntFunction<IntTuple> colexicographicalIndexer(IntTuple size)

Creates a function that maps multidimensional indices to 1D indices. The function will create consecutive 1D indices for indices that are given in colexicographical order.

Parameters:

size - The size of the array to index

Returns:

The indexer function

Throws:

NullPointerException - If the given size is null.