de.javagl.nd.tuples

Class Utils

java.lang.Object

de.javagl.nd.tuples.Utils

public class Utils
extends Object

Internal utility methods for the tuples package.

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

Method Summary

Modifier and Type	Method and Description
static void	checkForEqualSize(Tuple t0, Tuple t1) Checks whether given given Tuples have equal size, and throws an IllegalArgumentException if not.
static void	checkForValidIndex(int index, int size) Checks whether the given index is valid for accessing a tuple with the given size, and throws an IndexOutOfBoundsException if not.
static void	checkForValidSubTupleIndices(int parentSize, int fromIndex, int toIndex) Checks whether the given indices are valid indices for a sub-tuple of a parent tuple with the given size, and throws an IllegalArgumentException if not.

Methods inherited from class java.lang.Object

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

Method Detail

checkForEqualSize

public static void checkForEqualSize(Tuple t0,
                                     Tuple t1)

Checks whether given given Tuples have equal size, and throws an IllegalArgumentException if not.

Parameters:

t0 - The first tuple

t1 - The second tuple

Throws:

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

checkForValidSubTupleIndices

public static void checkForValidSubTupleIndices(int parentSize,
                                                int fromIndex,
                                                int toIndex)

Checks whether the given indices are valid indices for a sub-tuple of a parent tuple with the given size, and throws an IllegalArgumentException if not.

Parameters:

parentSize - The size of the parent

fromIndex - The start index of the sub-tuple, inclusive

toIndex - The end index of the sub-tuple, exclusive

Throws:

IllegalArgumentException - If the given indices are invalid. This is the case when fromIndex < 0, fromIndex > toIndex, or toIndex > parentSize,

checkForValidIndex

public static void checkForValidIndex(int index,
                                      int size)

Checks whether the given index is valid for accessing a tuple with the given size, and throws an IndexOutOfBoundsException if not.

Parameters:

index - The index

size - The size

Throws:

IndexOutOfBoundsException - If the given index is negative or not smaller than then given size