de.javagl.nd.tuples.i

Class IntTuples

java.lang.Object

de.javagl.nd.tuples.i.IntTuples

public class IntTuples
extends Object

Utility methods related to IntTuples.

Many of the methods in this class receive a mutable result tuple as the last parameter. Unless otherwise noted, this tuple will be returned by the function call. If the given result tuple is null, then a new tuple will be created and returned.

Unless otherwise noted: The result tuple may be identical to any of the input tuples.
Unless otherwise noted: The tuples that serve as the input for the methods may not be null

Method Summary

Modifier and Type	Method and Description
static MutableIntTuple	add(IntTuple t0, int value, MutableIntTuple result) Add the given value to all elements of the given input tuples, and store the result in the given result tuple.
static MutableIntTuple	add(IntTuple t0, IntTuple t1, MutableIntTuple result) Add the given input tuples, and store the result in the given result tuple.
static MutableIntTuple	addScaled(IntTuple t0, int factor, IntTuple t1, MutableIntTuple result) Computes t0+factor*t1, and stores the result in the given result tuple.
static boolean	areElementsGreaterThan(IntTuple t, int value) Returns whether all elements of the given tuple are greater than the given value.
static boolean	areElementsGreaterThan(IntTuple t0, IntTuple t1) Returns whether one tuple is element-wise greater than the other.
static boolean	areElementsGreaterThanOrEqual(IntTuple t, int value) Returns whether all elements of the given tuple are greater than or equal to the given value.
static boolean	areElementsGreaterThanOrEqual(IntTuple t0, IntTuple t1) Returns whether one tuple is element-wise greater than or equal to the other.
static boolean	areElementsLessThan(IntTuple t, int value) Returns whether all elements of the given tuple are less than the given value.
static boolean	areElementsLessThan(IntTuple t0, IntTuple t1) Returns whether one tuple is element-wise less than the other
static boolean	areElementsLessThanOrEqual(IntTuple t, int value) Returns whether all elements of the given tuple are less than or equal to the given value.
static boolean	areElementsLessThanOrEqual(IntTuple t0, IntTuple t1) Returns whether one tuple is element-wise less than or equal to the other
static List<Integer>	asList(IntTuple t) Returns a view on the given tuple as an unmodifiable list.
static List<Integer>	asList(MutableIntTuple t) Returns a view on the given tuple as a list that does not allow structural modifications.
static MutableIntTuple	clamp(IntTuple t, int min, int max, MutableIntTuple result) Clamp the components of the given tuple to be in the specified range, and write the result into the given result tuple.
static MutableIntTuple	clamp(IntTuple t, IntTuple min, IntTuple max, MutableIntTuple result) Clamp the components of the given tuple to be in the specified range, and write the result into the given result tuple.
static Comparator<IntTuple>	comparator(Order order) Returns a comparator that compares tuples based on the specified Order.
static int	compareColexicographically(IntTuple t0, IntTuple t1) Compares two tuples colexicographically, starting with the elements of the highest index.
static int	compareLexicographically(IntTuple t0, IntTuple t1) Compares two tuples lexicographically, starting with the elements of the lowest index.
static IntTuple	constant(int size, int value) Returns a tuple with the specified size, where each element is the given value.
static MutableIntTuple	copy(IntTuple other) Creates a new tuple which is a copy of the given one.
static MutableIntTuple	create(int size) Creates a new tuple with the given size.
static MutableIntTuple	divide(IntTuple t0, IntTuple t1, MutableIntTuple result) Divide the elements of the given input tuples, and store the results in the given result tuple.
static int	dot(IntTuple t0, IntTuple t1) Computes the dot product of the given tuples
static boolean	incrementColexicographically(IntTuple t, IntTuple min, IntTuple max, MutableIntTuple result) Colexicographically increment the given tuple in the given range, and store the result in the given result tuple.
static boolean	incrementLexicographically(IntTuple t, IntTuple min, IntTuple max, MutableIntTuple result) Lexicographically increment the given tuple in the given range, and store the result in the given result tuple.
static int	max(IntTuple t) Computes the maximum value that occurs in the given tuple, or Integer.MIN_VALUE if the given tuple has a size of 0.
static MutableIntTuple	max(IntTuple t0, IntTuple t1, MutableIntTuple result) Compute the element-wise maximum of the the given input tuples, and store the result in the given result tuple.
static int	min(IntTuple t) Computes the minimum value that occurs in the given tuple, or Integer.MAX_VALUE if the given tuple has a size of 0.
static MutableIntTuple	min(IntTuple t0, IntTuple t1, MutableIntTuple result) Compute the element-wise minimum of the the given input tuples, and store the result in the given result tuple.
static MutableIntTuple	multiply(IntTuple t0, int factor, MutableIntTuple result) Multiply the given input tuple with the given factor, and store the result in the given result tuple.
static MutableIntTuple	multiply(IntTuple t0, IntTuple t1, MutableIntTuple result) Multiply the elements of the given input tuples, and store the results in the given result tuple.
static MutableIntTuple	negate(IntTuple t0, MutableIntTuple result) Negates the given tuple, and store the result in the given result tuple.
static MutableIntTuple	of(int... values) Creates a new tuple with the given values.
static MutableIntTuple	of(int x) Creates a new MutableIntTuple with the given value.
static MutableIntTuple	of(int x, int y) Creates a new MutableIntTuple with the given values.
static MutableIntTuple	of(int x, int y, int z) Creates a new MutableIntTuple with the given values.
static MutableIntTuple	of(int x, int y, int z, int w) Creates a new MutableIntTuple with the given values.
static MutableIntTuple	reverse(IntTuple t, MutableIntTuple result) Reverse the given tuple.
static IntTuple	reversed(IntTuple t) Creates a new tuple that is a reversed view on the given tuple.
static MutableIntTuple	reversed(MutableIntTuple t) Creates a new tuple that is a reversed view on the given tuple.
static void	set(MutableIntTuple t, int v) Set all elements of the given tuple to the given value
static MutableIntTuple	subtract(IntTuple t0, int value, MutableIntTuple result) Subtract the given value from all elements of the given input tuple, and store the result in the given result tuple.
static MutableIntTuple	subtract(IntTuple t0, IntTuple t1, MutableIntTuple result) Subtract the given input tuples, and store the result in the given result tuple.
static int[]	toArray(IntTuple t) Creates a new array from the contents of the given tuple
static MutableDoubleTuple	toDoubleTuple(IntTuple intTuple) Convert the given IntTuple into a DoubleTuple
static String	toString(IntTuple tuple, int maxNumLeadingElements, int maxNumTrailingElements) Returns a string representation of the given tuple using toString(IntTuple, Locale, String, int, int) with the default locale and format.
static String	toString(IntTuple tuple, Locale locale, String format, int maxNumLeadingElements, int maxNumTrailingElements) Returns a string representation of the given tuple.
static MutableIntTuple	wrap(int... values) Creates a new tuple that is a view on the given values.
static MutableIntTuple	wrap(int[] data, int offset, int size) Returns a new tuple that is a view on the specified portion of the given array
static MutableIntTuple	wrap(IntBuffer buffer) Returns a new tuple that is a view on the given buffer.
static IntTuple	zero(int size) Returns a tuple with the specified size, containing all zeros.

Methods inherited from class java.lang.Object

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

Method Detail

zero

public static IntTuple zero(int size)

Returns a tuple with the specified size, containing all zeros.

Parameters:

size - The size

Returns:

The zero tuple.

Throws:

IllegalArgumentException - If the size is smaller than 0

constant

public static IntTuple constant(int size,
                                int value)

Returns a tuple with the specified size, where each element is the given value. Note that the returned tuple is storage-efficient, meaning that it its memory requirements are not depending on the given size.

Parameters:

size - The size

value - The value

Returns:

The tuple.

Throws:

IllegalArgumentException - If the size is smaller than 0

create

public static MutableIntTuple create(int size)

Creates a new tuple with the given size.

Parameters:

size - The size.

Returns:

The new tuple.

Throws:

IllegalArgumentException - If the size is smaller than 0

copy

public static MutableIntTuple copy(IntTuple other)

Creates a new tuple which is a copy of the given one.

Parameters:

other - The other tuple.

Returns:

The new tuple.

Throws:

NullPointerException - If the other tuple is null

of

public static MutableIntTuple of(int... values)

Creates a new tuple with the given values. The given array will be cloned, so that changes in the given array will not be visible in the returned tuple. In order to create a view on a given array, wrap(int...) may be used.

Parameters:

values - The values

Returns:

The new tuple

Throws:

NullPointerException - If the given array is null

wrap

public static MutableIntTuple wrap(int... values)

Creates a new tuple that is a view on the given values. Changes in the returned tuple will be visible in the given array, and vice versa.

Parameters:

values - The values

Returns:

The view on the given values

Throws:

NullPointerException - If the given array is null

wrap

public static MutableIntTuple wrap(IntBuffer buffer)

Returns a new tuple that is a view on the given buffer.

Parameters:

buffer - The buffer for the tuple

Returns:

The new tuple

Throws:

NullPointerException - If the given buffer is null

wrap

public static MutableIntTuple wrap(int[] data,
                                   int offset,
                                   int size)

Returns a new tuple that is a view on the specified portion of the given array

Parameters:

data - The data for the tuple

offset - The offset in the array

size - The size of the tuple

Returns:

The new tuple

Throws:

NullPointerException - If the given data array is null

IllegalArgumentException - If the given offset is negative, or if offset+size >= data.length

toArray

public static int[] toArray(IntTuple t)

Creates a new array from the contents of the given tuple

Parameters:

t - The tuple

Returns:

The array

asList

public static List<Integer> asList(IntTuple t)

Returns a view on the given tuple as an unmodifiable list. Changes in the backing tuple will be visible in the returned list.

Parameters:

t - The tuple

Returns:

The list

Throws:

NullPointerException - If the given tuple is null

asList

public static List<Integer> asList(MutableIntTuple t)

Returns a view on the given tuple as a list that does not allow structural modifications. Changes in the list will write through to the given tuple. Changes in the backing tuple will be visible in the returned list. The list will not permit null elements.

Parameters:

t - The tuple

Returns:

The list

Throws:

NullPointerException - If the given tuple is null

set

public static void set(MutableIntTuple t,
                       int v)

Set all elements of the given tuple to the given value

Parameters:

t - The tuple

v - The value

reverse

public static MutableIntTuple reverse(IntTuple t,
                                      MutableIntTuple result)

Reverse the given tuple.

Parameters:

t - The input tuple

result - The result tuple

Returns:

The result tuple

Throws:

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

reversed

public static IntTuple reversed(IntTuple t)

Creates a new tuple that is a reversed view on the given tuple. Changes in the given tuple will be visible in the returned tuple.

Parameters:

t - The tuple

Returns:

The reversed view on the tuple

Throws:

NullPointerException - If the given tuple is null

reversed

public static MutableIntTuple reversed(MutableIntTuple t)

Creates a new tuple that is a reversed view on the given tuple. Changes in the given tuple will be visible in the returned tuple, and vice versa.

Parameters:

t - The tuple

Returns:

The reversed view on the tuple

Throws:

NullPointerException - If the given tuple is null

clamp

public static MutableIntTuple clamp(IntTuple t,
                                    int min,
                                    int max,
                                    MutableIntTuple result)

Clamp the components of the given tuple to be in the specified range, and write the result into the given result tuple.

Parameters:

t - The input tuple

min - The minimum value

max - The maximum value

result - The result tuple

Returns:

The result tuple

Throws:

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

clamp

public static MutableIntTuple clamp(IntTuple t,
                                    IntTuple min,
                                    IntTuple max,
                                    MutableIntTuple result)

Clamp the components of the given tuple to be in the specified range, and write the result into the given result tuple.

Parameters:

t - The input tuple

min - The minimum values

max - The maximum values

result - The result tuple

Returns:

The result tuple

Throws:

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

negate

public static MutableIntTuple negate(IntTuple t0,
                                     MutableIntTuple result)

Negates the given tuple, and store the result in the given result tuple.

Parameters:

t0 - The tuple to negate

result - The tuple that will store the result

Returns:

The result tuple

add

public static MutableIntTuple add(IntTuple t0,
                                  IntTuple t1,
                                  MutableIntTuple result)

Add the given input tuples, and store the result in the given result tuple.

Parameters:

t0 - The first input tuple

t1 - The second input tuple

result - The tuple that will store the result

Returns:

The result tuple

Throws:

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

subtract

public static MutableIntTuple subtract(IntTuple t0,
                                       IntTuple t1,
                                       MutableIntTuple result)

Subtract the given input tuples, and store the result in the given result tuple.

Parameters:

t0 - The first input tuple

t1 - The second input tuple

result - The tuple that will store the result

Returns:

The result tuple

Throws:

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

multiply

public static MutableIntTuple multiply(IntTuple t0,
                                       IntTuple t1,
                                       MutableIntTuple result)

Multiply the elements of the given input tuples, and store the results in the given result tuple.

Parameters:

t0 - The first input tuple

t1 - The second input tuple

result - The tuple that will store the result

Returns:

The result tuple

Throws:

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

divide

public static MutableIntTuple divide(IntTuple t0,
                                     IntTuple t1,
                                     MutableIntTuple result)

Divide the elements of the given input tuples, and store the results in the given result tuple.

Parameters:

t0 - The first input tuple

t1 - The second input tuple

result - The tuple that will store the result

Returns:

The result tuple

Throws:

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

add

public static MutableIntTuple add(IntTuple t0,
                                  int value,
                                  MutableIntTuple result)

Add the given value to all elements of the given input tuples, and store the result in the given result tuple.

Parameters:

t0 - The first input tuple

value - The value to add

result - The tuple that will store the result

Returns:

The result tuple

Throws:

IllegalArgumentException - If the given tuple do not have the same size as the result tuple

subtract

public static MutableIntTuple subtract(IntTuple t0,
                                       int value,
                                       MutableIntTuple result)

Subtract the given value from all elements of the given input tuple, and store the result in the given result tuple.

Parameters:

t0 - The first input tuple

value - The value to add

result - The tuple that will store the result

Returns:

The result tuple

Throws:

IllegalArgumentException - If the given tuple do not have the same size as the result tuple

multiply

public static MutableIntTuple multiply(IntTuple t0,
                                       int factor,
                                       MutableIntTuple result)

Multiply the given input tuple with the given factor, and store the result in the given result tuple.

Parameters:

t0 - The input tuple

factor - The scaling factor

result - The tuple that will store the result

Returns:

The result tuple

Throws:

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

addScaled

public static MutableIntTuple addScaled(IntTuple t0,
                                        int factor,
                                        IntTuple t1,
                                        MutableIntTuple result)

Computes t0+factor*t1, and stores the result in the given result tuple.

Parameters:

t0 - The first input tuple

factor - The scaling factor

t1 - The second input tuple

result - The tuple that will store the result

Returns:

The result tuple

Throws:

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

dot

public static int dot(IntTuple t0,
                      IntTuple t1)

Computes the dot product of the given tuples

Parameters:

t0 - The first input tuple

t1 - The second input tuple

Returns:

The dot product

Throws:

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

min

public static int min(IntTuple t)

Computes the minimum value that occurs in the given tuple, or Integer.MAX_VALUE if the given tuple has a size of 0.

Parameters:

t - The input tuple

Returns:

The minimum value

max

public static int max(IntTuple t)

Computes the maximum value that occurs in the given tuple, or Integer.MIN_VALUE if the given tuple has a size of 0.

Parameters:

t - The input tuple

Returns:

The maximum value

min

public static MutableIntTuple min(IntTuple t0,
                                  IntTuple t1,
                                  MutableIntTuple result)

Compute the element-wise minimum of the the given input tuples, and store the result in the given result tuple.

Parameters:

t0 - The first input tuple

t1 - The second input tuple

result - The tuple that will store the result

Returns:

The result tuple

Throws:

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

max

public static MutableIntTuple max(IntTuple t0,
                                  IntTuple t1,
                                  MutableIntTuple result)

Compute the element-wise maximum of the the given input tuples, and store the result in the given result tuple.

Parameters:

t0 - The first input tuple

t1 - The second input tuple

result - The tuple that will store the result

Returns:

The result tuple

Throws:

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

compareLexicographically

public static int compareLexicographically(IntTuple t0,
                                           IntTuple t1)

Compares two tuples lexicographically, starting with the elements of the lowest index.

Parameters:

t0 - The first tuple

t1 - The second tuple

Returns:

-1 if the first tuple is lexicographically smaller than the second, +1 if it is larger, and 0 if they are equal.

Throws:

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

compareColexicographically

public static int compareColexicographically(IntTuple t0,
                                             IntTuple t1)

Compares two tuples colexicographically, starting with the elements of the highest index.

Parameters:

t0 - The first tuple

t1 - The second tuple

Returns:

-1 if the first tuple is colexicographically smaller than the second, +1 if it is larger, and 0 if they are equal.

Throws:

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

comparator

public static Comparator<IntTuple> comparator(Order order)

Returns a comparator that compares tuples based on the specified Order. If the given order is null, then null will be returned.

Parameters:

order - The Order

Returns:

The comparator.

areElementsGreaterThan

public static boolean areElementsGreaterThan(IntTuple t0,
                                             IntTuple t1)

Returns whether one tuple is element-wise greater than the other.

Parameters:

t0 - The first tuple

t1 - The second tuple

Returns:

Whether each element of the first tuple is greater than the corresponding element of the second tuple.

Throws:

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

areElementsGreaterThanOrEqual

public static boolean areElementsGreaterThanOrEqual(IntTuple t0,
                                                    IntTuple t1)

Returns whether one tuple is element-wise greater than or equal to the other.

Parameters:

t0 - The first tuple

t1 - The second tuple

Returns:

Whether each element of the first tuple is greater than or equal to the corresponding element of the second tuple.

Throws:

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

areElementsLessThan

public static boolean areElementsLessThan(IntTuple t0,
                                          IntTuple t1)

Returns whether one tuple is element-wise less than the other

Parameters:

t0 - The first tuple

t1 - The second tuple

Returns:

Whether each element of the first tuple is smaller than the corresponding element of the second tuple.

Throws:

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

areElementsLessThanOrEqual

public static boolean areElementsLessThanOrEqual(IntTuple t0,
                                                 IntTuple t1)

Returns whether one tuple is element-wise less than or equal to the other

Parameters:

t0 - The first tuple

t1 - The second tuple

Returns:

Whether each element of the first tuple is less than or equal to the corresponding element of the second tuple.

Throws:

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

areElementsGreaterThan

public static boolean areElementsGreaterThan(IntTuple t,
                                             int value)

Returns whether all elements of the given tuple are greater than the given value.

Parameters:

t - The tuple

value - The value to compare to

Returns:

Whether each element of the tuple is greater than the given value

areElementsGreaterThanOrEqual

public static boolean areElementsGreaterThanOrEqual(IntTuple t,
                                                    int value)

Returns whether all elements of the given tuple are greater than or equal to the given value.

Parameters:

t - The tuple

value - The value to compare to

Returns:

Whether each element of the tuple is greater than or equal to the given value

areElementsLessThan

public static boolean areElementsLessThan(IntTuple t,
                                          int value)

Returns whether all elements of the given tuple are less than the given value.

Parameters:

t - The tuple

value - The value to compare to

Returns:

Whether each element of the tuple is less than the given value

areElementsLessThanOrEqual

public static boolean areElementsLessThanOrEqual(IntTuple t,
                                                 int value)

Returns whether all elements of the given tuple are less than or equal to the given value.

Parameters:

t - The tuple

value - The value to compare to

Returns:

Whether each element of the tuple is less than or equal to the given value

toString

public static String toString(IntTuple tuple,
                              int maxNumLeadingElements,
                              int maxNumTrailingElements)

Returns a string representation of the given tuple using toString(IntTuple, Locale, String, int, int) with the default locale and format.

Parameters:

tuple - The tuple

maxNumLeadingElements - The maximum number of leading elements

maxNumTrailingElements - The maximum number of trailing elements

Returns:

The string

toString

public static String toString(IntTuple tuple,
                              Locale locale,
                              String format,
                              int maxNumLeadingElements,
                              int maxNumTrailingElements)

Returns a string representation of the given tuple. If the given tuple has a size that is larger than the sum of the given numbers of leading and trailing elements, then the string contents will be abbreviated with an ellipsis: "...".

Examples for a tuple with size 6:
toString(t, 3, 1) : (0, 0, 0, ..., 0)
toString(t, 2, 0) : (0, 0, ...)
toString(t, 0, 2) : (..., 0, 0)
toString(t, 9, 9) : (0, 0, 0, 0, 0, 0)

The given numbers of elements will be clamped to be nonnegative.

Parameters:

tuple - The tuple

locale - The locale. If this is null, then a canonical string representation of the elements will be used.

format - The format. If this is null, then a canonical string representation of the elements will be used.

maxNumLeadingElements - The maximum number of leading elements

maxNumTrailingElements - The maximum number of trailing elements

Returns:

The string

toDoubleTuple

public static MutableDoubleTuple toDoubleTuple(IntTuple intTuple)

Convert the given IntTuple into a DoubleTuple

Parameters:

intTuple - The IntTuple

Returns:

The MutableDoubleTuple

of

public static MutableIntTuple of(int x)

Creates a new MutableIntTuple with the given value.

Parameters:

x - The x coordinate

Returns:

The new tuple

of

public static MutableIntTuple of(int x,
                                 int y)

Creates a new MutableIntTuple with the given values.

Parameters:

x - The x coordinate

y - The y coordinate

Returns:

The new tuple

of

public static MutableIntTuple of(int x,
                                 int y,
                                 int z)

Creates a new MutableIntTuple with the given values.

Parameters:

x - The x coordinate

y - The y coordinate

z - The z coordinate

Returns:

The new tuple

of

public static MutableIntTuple of(int x,
                                 int y,
                                 int z,
                                 int w)

Creates a new MutableIntTuple with the given values.

Parameters:

x - The x coordinate

y - The y coordinate

z - The z coordinate

w - The w coordinate

Returns:

The new tuple

incrementLexicographically

public static boolean incrementLexicographically(IntTuple t,
                                                 IntTuple min,
                                                 IntTuple max,
                                                 MutableIntTuple result)

Lexicographically increment the given tuple in the given range, and store the result in the given result tuple. It is assumed that the elements of the given tuple are greater than or equal to the values in the given minimum tuple.

Note that in contrast to most other methods in this class, the given result tuple may not be null (but it may be identical to the input tuple).

Parameters:

t - The input tuple

min - The minimum values

max - The maximum values

result - The result tuple

Returns:

Whether the tuple could be incremented without causing an overflow

incrementColexicographically

public static boolean incrementColexicographically(IntTuple t,
                                                   IntTuple min,
                                                   IntTuple max,
                                                   MutableIntTuple result)

Colexicographically increment the given tuple in the given range, and store the result in the given result tuple. It is assumed that the elements of the given tuple are greater than or equal to the values in the given minimum tuple.

Note that in contrast to most other methods in this class, the given result tuple may not be null (but it may be identical to the input tuple).

Parameters:

t - The input tuple

min - The minimum values

max - The maximum values

result - The result tuple

Returns:

Whether the tuple could be incremented without causing an overflow