de.javagl.nd.arrays.i

Class IntArraysND

java.lang.Object

de.javagl.nd.arrays.i.IntArraysND

public class IntArraysND
extends Object

Methods related to IntArrayND instances

Method Summary

Modifier and Type	Method and Description
static java.util.function.ToIntFunction<IntTuple>	asFunction(IntArrayND array) Returns a view on the given IntArrayND as a function that maps coordinates to array entry values.
static MutableIntArrayND	create(int... size) Creates a new MutableIntArrayND with the specified size
static MutableIntArrayND	create(IntTuple size) Creates a new MutableIntArrayND with the specified size
static IntArrayND	createSubArray(IntArrayND parent, IntTuple fromIndices, IntTuple toIndices) Creates a new array that is a view on the specified portion of the given parent.
static MutableIntArrayND	createSubArray(MutableIntArrayND parent, IntTuple fromIndices, IntTuple toIndices) Creates a new array that is a view on the specified portion of the given parent.
static int	max(IntArrayND array) Returns the maximum value in the given array, or Integer.MIN_VALUE if the given array has a size of 0.
static int	min(IntArrayND array) Returns the minimum value in the given array, or Integer.MAX_VALUE if the given array has a size of 0.
static String	toFormattedString(IntArrayND array) Creates a formatted representation of the given array.
static String	toFormattedString(IntArrayND array, String format) Creates a formatted representation of the given array.
static MutableIntArrayND	wrap(int[][] array) Creates a view on the given array as a MutableIntArrayND.
static IntArrayND	wrap(IntTuple t, IntTuple size) Creates a view on the given tuple as a IntArrayND.
static MutableIntArrayND	wrap(MutableIntTuple t, IntTuple size) Creates a view on the given tuple as a IntArrayND.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static MutableIntArrayND create(IntTuple size)

Creates a new MutableIntArrayND with the specified size

Parameters:

size - The size

Returns:

The new array

Throws:

NullPointerException - If the given size is null

IllegalArgumentException - If the given size is negative along any dimension

create

public static MutableIntArrayND create(int... size)

Creates a new MutableIntArrayND with the specified size

Parameters:

size - The size

Returns:

The new array

Throws:

NullPointerException - If the given size is null

IllegalArgumentException - If the given size is negative along any dimension

wrap

public static MutableIntArrayND wrap(int[][] array)

Creates a view on the given array as a MutableIntArrayND. Changes in the given array will be visible in the returned array, and vice versa.

The given array is assumed to be rectangular (and to not contain null elements).

Parameters:

array - The backing array

Returns:

The view on the array

Throws:

NullPointerException - If the given array is null

wrap

public static IntArrayND wrap(IntTuple t,
                              IntTuple size)

Creates a view on the given tuple as a IntArrayND. Changes in the given tuple will be visible in the returned array.

Parameters:

t - The tuple

size - The size of the array

Returns:

The view on the tuple

Throws:

NullPointerException - If any argument is null

IllegalArgumentException - If the size of the tuple does not match the given array size (that is, the product of all elements of the given tuple).

wrap

public static MutableIntArrayND wrap(MutableIntTuple t,
                                     IntTuple size)

Creates a view on the given tuple as a IntArrayND. Changes in the given tuple will be visible in the returned array, and vice versa.

Parameters:

t - The tuple

size - The size of the array

Returns:

The view on the tuple

Throws:

NullPointerException - If any argument is null

IllegalArgumentException - If the size of the tuple does not match the given array size (that is, the product of all elements of the given tuple).

asFunction

public static java.util.function.ToIntFunction<IntTuple> asFunction(IntArrayND array)

Returns a view on the given IntArrayND as a function that maps coordinates to array entry values. This function may throw an IndexOutOfBoundsException when the given 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.

Parameters:

array - The array

Returns:

The function

Throws:

NullPointerException - If the given array is null

createSubArray

public static IntArrayND createSubArray(IntArrayND parent,
                                        IntTuple fromIndices,
                                        IntTuple toIndices)

Creates a new array that is a view on the specified portion of the given parent. Changes in the parent will be visible in the returned array.

Parameters:

parent - The parent array

fromIndices - The start indices in the parent, inclusive

toIndices - The end indices in the parent, exclusive

Returns:

The new array

Throws:

NullPointerException - If any argument is 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 parent size, or when fromIndex < 0 or toIndex > parentSize(i) or fromIndex > toIndex for any dimension.

createSubArray

public static MutableIntArrayND createSubArray(MutableIntArrayND parent,
                                               IntTuple fromIndices,
                                               IntTuple toIndices)

Creates a new array that is a view on the specified portion of the given parent. Changes in the parent will be visible in the returned array, and vice versa. The returned array will use lexicographical iteration order.

Parameters:

parent - The parent array

fromIndices - The start indices in the parent, inclusive

toIndices - The end indices in the parent, exclusive

Returns:

The new array

Throws:

NullPointerException - If the given parent or any of the given tuples is 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 parent size, or when fromIndex < 0 or toIndex > parentSize(i) or fromIndex > toIndex for any dimension.

min

public static int min(IntArrayND array)

Returns the minimum value in the given array, or Integer.MAX_VALUE if the given array has a size of 0.

Parameters:

array - The array

Returns:

The minimum value

max

public static int max(IntArrayND array)

Returns the maximum value in the given array, or Integer.MIN_VALUE if the given array has a size of 0.

Parameters:

array - The array

Returns:

The maximum value

toFormattedString

public static String toFormattedString(IntArrayND array)

Creates a formatted representation of the given array. After each dimension, a newline character will be inserted.

Parameters:

array - The array

Returns:

The hash code

toFormattedString

public static String toFormattedString(IntArrayND array,
                                       String format)

Creates a formatted representation of the given array. After each dimension, a newline character will be inserted.

Parameters:

array - The array

format - The format for the array entries

Returns:

The hash code