de.javagl.nd.tuples.d

Class DoubleTupleFunctions

java.lang.Object

de.javagl.nd.tuples.d.DoubleTupleFunctions

public class DoubleTupleFunctions
extends Object

Methods that perform bulk operations on the elements of DoubleTuples 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 MutableDoubleTuple	apply(DoubleTuple t0, DoubleTuple t1, java.util.function.DoubleBinaryOperator op, MutableDoubleTuple 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 MutableDoubleTuple	apply(DoubleTuple t0, java.util.function.DoubleUnaryOperator op, MutableDoubleTuple result) Applies the given unary operator to element from the given tuple, and stores the result in the given result tuple.
static MutableDoubleTuple	exclusiveScan(DoubleTuple t0, double identity, java.util.function.DoubleBinaryOperator op, MutableDoubleTuple 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 MutableDoubleTuple	inclusiveScan(DoubleTuple t0, java.util.function.DoubleBinaryOperator op, MutableDoubleTuple result) Performs an inclusive scan on the elements of the given tuple, using the provided associative accumulation function, and returns the result.
static double	reduce(DoubleTuple t0, double identity, java.util.function.DoubleBinaryOperator 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 MutableDoubleTuple apply(DoubleTuple t0,
                                       DoubleTuple t1,
                                       java.util.function.DoubleBinaryOperator op,
                                       MutableDoubleTuple 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 MutableDoubleTuple apply(DoubleTuple t0,
                                       java.util.function.DoubleUnaryOperator op,
                                       MutableDoubleTuple 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 double reduce(DoubleTuple t0,
                            double identity,
                            java.util.function.DoubleBinaryOperator 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 MutableDoubleTuple inclusiveScan(DoubleTuple t0,
                                               java.util.function.DoubleBinaryOperator op,
                                               MutableDoubleTuple 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 MutableDoubleTuple exclusiveScan(DoubleTuple t0,
                                               double identity,
                                               java.util.function.DoubleBinaryOperator op,
                                               MutableDoubleTuple 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