de.javagl.nd.arrays

Class Utils

java.lang.Object

de.javagl.nd.arrays.Utils

public class Utils
extends Object

Internal utility methods for the arrays package.

These methods should not be considered as being a part of the public API.

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static void	checkForEqualDimensions(ArrayND a0, ArrayND a1) Checks whether given given ArrayNDs have equal dimensions, and throws an IllegalArgumentException if not.
static void	checkForEqualSizes(ArrayND a0, ArrayND a1) Checks whether given given ArrayNDs have equal sizes, and throws an IllegalArgumentException if not.
static void	checkForNonNegativeElements(IntTuple t) Checks whether the elements of the given tuple are not negative, and throws an IllegalArgumentException if any of them is negative.
static void	checkForValidSubArrayIndices(IntTuple parentSize, IntTuple fromIndices, IntTuple toIndices) Checks whether the given tuples specify a valid range for a sub-array of an array with the given parent size, and throws an IllegalArgumentException if not.
static int	countDifferences(IntTuple t0, IntTuple t1) Returns the number of entries of the given tuples that are different

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

checkForEqualDimensions

public static void checkForEqualDimensions(ArrayND a0,
                                           ArrayND a1)

Checks whether given given ArrayNDs have equal dimensions, and throws an IllegalArgumentException if not.

Parameters:

a0 - The first array

a1 - The second array

Throws:

NullPointerException - If any argument is null

IllegalArgumentException - If the given arrays do not have equal dimensions

checkForEqualSizes

public static void checkForEqualSizes(ArrayND a0,
                                      ArrayND a1)

Checks whether given given ArrayNDs have equal sizes, and throws an IllegalArgumentException if not.

Parameters:

a0 - The first array

a1 - The second array

Throws:

NullPointerException - If any argument is null

IllegalArgumentException - If the given arrays do not have equal sizes

checkForNonNegativeElements

public static void checkForNonNegativeElements(IntTuple t)

Checks whether the elements of the given tuple are not negative, and throws an IllegalArgumentException if any of them is negative.

Parameters:

t - The tuple

Throws:

NullPointerException - If the given size is null

IllegalArgumentException - If any element of the given tuple is negative

checkForValidSubArrayIndices

public static void checkForValidSubArrayIndices(IntTuple parentSize,
                                                IntTuple fromIndices,
                                                IntTuple toIndices)

Checks whether the given tuples specify a valid range for a sub-array of an array with the given parent size, and throws an IllegalArgumentException if not.

Parameters:

parentSize - The parent size

fromIndices - The start indices, inclusive

toIndices - The end indices, exclusive

Throws:

NullPointerException - If 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.get(i) or fromIndex > toIndex for any dimension.

countDifferences

public static int countDifferences(IntTuple t0,
                                   IntTuple t1)

Returns the number of entries of the given tuples that are different

Parameters:

t0 - The first tuple

t1 - The second tuple

Returns:

The number of differences

Throws:

NullPointerException - If any of the arguments is null

IllegalArgumentException - If the given tuples do not have the same size