de.javagl.nd.tuples.i

Class IntTupleFunctions

java.lang.Object

de.javagl.nd.tuples.i.IntTupleFunctions

public class IntTupleFunctions
extends Object

Methods that perform bulk operations on the elements of IntTuples using functional interfaces.

Unless otherwise noted, none of the arguments passed to these methods may be null.

Method Summary

Modifier and Type	Method and Description
static MutableIntTuple	apply(IntTuple t0, IntTuple t1, java.util.function.IntBinaryOperator op, MutableIntTuple result) Applies the given binary operator to each pair of elements from the given tuples, and stores the result in the given result tuple.
static MutableIntTuple	apply(IntTuple t0, java.util.function.IntUnaryOperator op, MutableIntTuple result) Applies the given unary operator to element from the given tuple, and stores the result in the given result tuple.
static MutableIntTuple	exclusiveScan(IntTuple t0, int identity, java.util.function.IntBinaryOperator op, MutableIntTuple result) Performs an exclusive scan on the elements of the given tuple, using the provided identity value and associative accumulation function, and returns the result.
static MutableIntTuple	inclusiveScan(IntTuple t0, java.util.function.IntBinaryOperator op, MutableIntTuple result) Performs an inclusive scan on the elements of the given tuple, using the provided associative accumulation function, and returns the result.
static int	reduce(IntTuple t0, int identity, java.util.function.IntBinaryOperator op) Performs a reduction on the elements of the given tuple, using the provided identity value and an associative accumulation function, and returns the reduced value.

Methods inherited from class java.lang.Object

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

Method Detail

apply

public static MutableIntTuple apply(IntTuple t0,
                                    IntTuple t1,
                                    java.util.function.IntBinaryOperator op,
                                    MutableIntTuple result)

Applies the given binary operator to each pair of elements from the given tuples, and stores the result in the given result tuple. If the given result tuple is null, then a new tuple will be created and returned.

Parameters:

t0 - The first tuple

t1 - The second tuple

op - The operator to apply

result - The tuple that will store the result

Returns:

The result

Throws:

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

apply

public static MutableIntTuple apply(IntTuple t0,
                                    java.util.function.IntUnaryOperator op,
                                    MutableIntTuple result)

Applies the given unary operator to element from the given tuple, and stores the result in the given result tuple. If the given result tuple is null, then a new tuple will be created and returned.

Parameters:

t0 - The tuple

op - The operator to apply

result - The tuple that will store the result

Returns:

The result

Throws:

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

reduce

public static int reduce(IntTuple t0,
                         int identity,
                         java.util.function.IntBinaryOperator op)

Performs a reduction on the elements of the given tuple, using the provided identity value and an associative accumulation function, and returns the reduced value.

Parameters:

t0 - The tuple

identity - The identity value

op - The accumulation function

Returns:

The result

inclusiveScan

public static MutableIntTuple inclusiveScan(IntTuple t0,
                                            java.util.function.IntBinaryOperator op,
                                            MutableIntTuple result)

Performs an inclusive scan on the elements of the given tuple, using the provided associative accumulation function, and returns the result.

If the given result tuple is null, then a new tuple will be created and returned.

The result tuple may be identical to the input tuple.

Parameters:

t0 - The tuple

op - The accumulation function

result - The result

Returns:

The result

Throws:

IllegalArgumentException - If the given result tuple is not null and has a different size than the input tuple

exclusiveScan

public static MutableIntTuple exclusiveScan(IntTuple t0,
                                            int identity,
                                            java.util.function.IntBinaryOperator op,
                                            MutableIntTuple result)

Performs an exclusive scan on the elements of the given tuple, using the provided identity value and associative accumulation function, and returns the result.

If the given result tuple is null, then a new tuple will be created and returned.

The result tuple may be identical to the input tuple.

Parameters:

t0 - The tuple

identity - The identity value

op - The accumulation function

result - The result

Returns:

The result

Throws:

IllegalArgumentException - If the given result tuple is not null and has a different size than the input tuple