de.javagl.nd.tuples.i

Class IntTupleCollections

java.lang.Object

de.javagl.nd.tuples.i.IntTupleCollections

public class IntTupleCollections
extends Object

Utility methods related to collections of IntTuple instances.

For the methods that receive a collection of input tuples and a result tuple, unless otherwise noted, the behavior is as follows:

• If the input collection is empty, then null will be returned
• If the input collection is not empty:
  • If the result tuple is null, then a new tuple will be created and returned.
  • If the result tuple is not null, then it will be verified that the result tuple has an appropriate size for the respective operation, and an IllegalArgumentException will be thrown if this is not the case.

All these methods assume that the collections do not contain null elements, and that the size of all tuples is the same. If this is not the case, the behavior is unspecified (although in most cases, a NullPointerException or an IllegalArgumentException will be thrown, respectively)

Method Summary

Modifier and Type	Method and Description
static MutableIntTuple	add(Collection<? extends IntTuple> tuples, MutableIntTuple result) Computes the component-wise sum of the given collection of tuples.
static List<MutableIntTuple>	create(int dimensions, int numElements) Create the specified number of tuples with the given dimensions (size), all initialized to zero, and return them as a list
static void	create(int dimensions, int numElements, Collection<? super MutableIntTuple> target) Create the specified number of tuples with the given dimensions (size), all initialized to zero, and place them into the given target collection
static List<MutableIntTuple>	deepCopy(Collection<? extends IntTuple> tuples) Returns a deep copy of the given collection of tuples.
static MutableIntTuple	max(Collection<? extends IntTuple> tuples, MutableIntTuple result) Computes the component-wise maximum of the given collection of tuples.
static MutableIntTuple	min(Collection<? extends IntTuple> tuples, MutableIntTuple result) Computes the component-wise minimum of the given collection of tuples.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static void create(int dimensions,
                          int numElements,
                          Collection<? super MutableIntTuple> target)

Create the specified number of tuples with the given dimensions (size), all initialized to zero, and place them into the given target collection

Parameters:

dimensions - The dimensions (size) of the tuples to create

numElements - The number of tuples to create

target - The target collection

Throws:

IllegalArgumentException - If the given dimensions are negative

create

public static List<MutableIntTuple> create(int dimensions,
                                           int numElements)

Create the specified number of tuples with the given dimensions (size), all initialized to zero, and return them as a list

Parameters:

dimensions - The dimensions (size) of the tuples to create

numElements - The number of tuples to create

Returns:

The list

Throws:

IllegalArgumentException - If the given dimensions are negative

deepCopy

public static List<MutableIntTuple> deepCopy(Collection<? extends IntTuple> tuples)

Returns a deep copy of the given collection of tuples. If any element of the given collection is null, then null will also be added to the target collection.

Parameters:

tuples - The input tuples

Returns:

The deep copy

min

public static MutableIntTuple min(Collection<? extends IntTuple> tuples,
                                  MutableIntTuple result)

Computes the component-wise minimum of the given collection of tuples.

If the given collection is not empty, and the given result is null, then a new tuple with the same size as the first tuple of the collection will be created internally. All elements of this tuple will be initialized with Integer.MAX_VALUE.

Parameters:

tuples - The input tuples

result - The result tuple

Returns:

The result, or null if the given collection is empty

Throws:

IllegalArgumentException - If the given result is not null, and has a size that is different from that of the input tuples.

max

public static MutableIntTuple max(Collection<? extends IntTuple> tuples,
                                  MutableIntTuple result)

Computes the component-wise maximum of the given collection of tuples.

If the given collection is not empty, and the given result is null, then a new tuple with the same size as the first tuple of the collection will be created internally. All elements of this tuple will be initialized with Integer.MIN_VALUE.

Parameters:

tuples - The input tuples

result - The result tuple

Returns:

The result, or null if the given collection is empty

Throws:

IllegalArgumentException - If the given result is not null, and has a size that is different from that of the input tuples.

add

public static MutableIntTuple add(Collection<? extends IntTuple> tuples,
                                  MutableIntTuple result)

Computes the component-wise sum of the given collection of tuples.

If the given collection is not empty, and the given result is null, then a new tuple with the same size as the first tuple of the collection will be created internally.

Parameters:

tuples - The input tuples

result - The result tuple

Returns:

The result, or null if the given collection is empty

Throws:

IllegalArgumentException - If the given result is not null, and has a size that is different from that of the input tuples.