de.javagl.nd.tuples.d

Class DoubleTuples

java.lang.Object

de.javagl.nd.tuples.d.DoubleTuples

public class DoubleTuples
extends Object

Utility methods related to DoubleTuples.

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 MutableDoubleTuple	add(DoubleTuple t0, double value, MutableDoubleTuple result) Add the given value to all elements of the given input tuples, and store the result in the given result tuple.
static MutableDoubleTuple	add(DoubleTuple t0, DoubleTuple t1, MutableDoubleTuple result) Add the given input tuples, and store the result in the given result tuple.
static MutableDoubleTuple	addScaled(DoubleTuple t0, double factor, DoubleTuple t1, MutableDoubleTuple result) Computes t0+factor*t1, and stores the result in the given result tuple.
static boolean	areElementsGreaterThan(DoubleTuple t, double value) Returns whether all elements of the given tuple are greater than the given value.
static boolean	areElementsGreaterThan(DoubleTuple t0, DoubleTuple t1) Returns whether one tuple is element-wise greater than the other.
static boolean	areElementsGreaterThanOrEqual(DoubleTuple t, double value) Returns whether all elements of the given tuple are greater than or equal to the given value.
static boolean	areElementsGreaterThanOrEqual(DoubleTuple t0, DoubleTuple t1) Returns whether one tuple is element-wise greater than or equal to the other.
static boolean	areElementsLessThan(DoubleTuple t, double value) Returns whether all elements of the given tuple are less than the given value.
static boolean	areElementsLessThan(DoubleTuple t0, DoubleTuple t1) Returns whether one tuple is element-wise less than the other
static boolean	areElementsLessThanOrEqual(DoubleTuple t, double value) Returns whether all elements of the given tuple are less than or equal to the given value.
static boolean	areElementsLessThanOrEqual(DoubleTuple t0, DoubleTuple t1) Returns whether one tuple is element-wise less than or equal to the other
static double	arithmeticMean(DoubleTuple t) Returns the arithmetic mean of the given tuple
static List<Double>	asList(DoubleTuple t) Returns a view on the given tuple as an unmodifiable list.
static List<Double>	asList(MutableDoubleTuple t) Returns a view on the given tuple as a list that does not allow structural modifications.
static MutableDoubleTuple	clamp(DoubleTuple t, double min, double max, MutableDoubleTuple result) Clamp the components of the given tuple to be in the specified range, and write the result into the given result tuple.
static MutableDoubleTuple	clamp(DoubleTuple t, DoubleTuple min, DoubleTuple max, MutableDoubleTuple 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<DoubleTuple>	comparator(Order order) Returns a comparator that compares tuples based on the specified Order.
static int	compareColexicographically(DoubleTuple t0, DoubleTuple t1) Compares two tuples colexicographically, starting with the elements of the highest index.
static int	compareLexicographically(DoubleTuple t0, DoubleTuple t1) Compares two tuples lexicographically, starting with the elements of the lowest index.
static double	computeL2(DoubleTuple t) Computes the L2 norm (euclidean length) of the given tuple
static DoubleTuple	constant(int size, double value) Returns a tuple with the specified size, where each element is the given value.
static boolean	containsNaN(DoubleTuple tuple) Returns whether the given tuple contains an element that is Not A Number
static MutableDoubleTuple	copy(DoubleTuple other) Creates a new tuple which is a copy of the given one.
static MutableDoubleTuple	create(int size) Creates a new tuple with the given size.
static MutableDoubleTuple	createRandom(int size, double min, double max, Random random) Creates a tuple with the given size that is filled with random values in the given range.
static MutableDoubleTuple	createRandom(int size, Random random) Creates a tuple with the given size that is filled with random values in [0,1)
static MutableDoubleTuple	createRandomGaussian(int size, Random random) Creates a tuple with the given size that was filled with values from a gaussian distribution with mean 0.0 and standard deviation 1.0
static MutableDoubleTuple	divide(DoubleTuple t0, DoubleTuple t1, MutableDoubleTuple result) Divide the elements of the given input tuples, and store the results in the given result tuple.
static double	dot(DoubleTuple t0, DoubleTuple t1) Computes the dot product of the given tuples
static MutableDoubleTuple	interpolate(DoubleTuple t0, DoubleTuple t1, double alpha, MutableDoubleTuple result) Computes t0+alpha*(t1-t0), and stores the result in the given result tuple.
static double	max(DoubleTuple t) Computes the maximum value that occurs in the given tuple, or Double.NEGATIVE_INFINITY if the given tuple has a size of 0.
static MutableDoubleTuple	max(DoubleTuple t0, DoubleTuple t1, MutableDoubleTuple result) Compute the element-wise maximum of the the given input tuples, and store the result in the given result tuple.
static double	min(DoubleTuple t) Computes the minimum value that occurs in the given tuple, or Double.POSITIVE_INFINITY if the given tuple has a size of 0.
static MutableDoubleTuple	min(DoubleTuple t0, DoubleTuple t1, MutableDoubleTuple result) Compute the element-wise minimum of the the given input tuples, and store the result in the given result tuple.
static MutableDoubleTuple	multiply(DoubleTuple t0, double factor, MutableDoubleTuple result) Multiply the given input tuple with the given factor, and store the result in the given result tuple.
static MutableDoubleTuple	multiply(DoubleTuple t0, DoubleTuple t1, MutableDoubleTuple result) Multiply the elements of the given input tuples, and store the results in the given result tuple.
static MutableDoubleTuple	negate(DoubleTuple t0, MutableDoubleTuple result) Negates the given tuple, and store the result in the given result tuple.
static MutableDoubleTuple	normalize(DoubleTuple t, MutableDoubleTuple result) Normalize the given tuple and write the result into the given result tuple.
static MutableDoubleTuple	normalizeElements(DoubleTuple t, double min, double max, MutableDoubleTuple result) Normalize the elements of the given tuple, so that its minimum and maximum elements match the given minimum and maximum values.
static MutableDoubleTuple	normalizeElements(DoubleTuple t, DoubleTuple min, DoubleTuple max, MutableDoubleTuple result) Normalize the elements of the given tuple, so that each element will be linearly rescaled to the interval defined by the corresponding elements of the given minimum and maximum tuple.
static MutableDoubleTuple	of(double... values) Creates a new tuple with the given values.
static void	randomize(MutableDoubleTuple t, double min, double max, Random random) Fill the given tuple with random values in the specified range, using the given random number generator
static void	randomize(MutableDoubleTuple t, Random random) Fill the given tuple with random values in [0,1), using the given random number generator
static void	randomizeGaussian(MutableDoubleTuple t, Random random) Randomize the given tuple with a gaussian distribution with a mean of 0.0 and standard deviation of 1.0
static MutableDoubleTuple	rescaleElements(DoubleTuple t, double oldMin, double oldMax, double newMin, double newMax, MutableDoubleTuple result) Rescale the elements of the given tuple, so that the specified old range is mapped to the specified new range.
static MutableDoubleTuple	reverse(DoubleTuple t, MutableDoubleTuple result) Reverse the given tuple.
static DoubleTuple	reversed(DoubleTuple t) Creates a new tuple that is a reversed view on the given tuple.
static MutableDoubleTuple	reversed(MutableDoubleTuple t) Creates a new tuple that is a reversed view on the given tuple.
static void	set(MutableDoubleTuple t, double v) Set all elements of the given tuple to the given value
static double	standardDeviation(DoubleTuple t) Returns the standard deviation of the given tuple.
static double	standardDeviationFromMean(DoubleTuple t, double mean) Returns the standard deviation of the given tuple.
static MutableDoubleTuple	standardDeviationFromVariance(DoubleTuple variance, MutableDoubleTuple result) Returns the standard deviation of the given variances (that is, a tuple containing the square roots of the values in the given tuple).
static MutableDoubleTuple	standardize(DoubleTuple t, MutableDoubleTuple result) Standardize the given tuple.
static MutableDoubleTuple	subtract(DoubleTuple t0, double value, MutableDoubleTuple result) Subtract the given value from all elements of the given input tuple, and store the result in the given result tuple.
static MutableDoubleTuple	subtract(DoubleTuple t0, DoubleTuple t1, MutableDoubleTuple result) Subtract the given input tuples, and store the result in the given result tuple.
static double[]	toArray(DoubleTuple t) Creates a new array from the contents of the given tuple
static String	toString(DoubleTuple tuple, int maxNumLeadingElements, int maxNumTrailingElements) Returns a string representation of the given tuple using toString(DoubleTuple, Locale, String, int, int) with the default locale and format.
static String	toString(DoubleTuple tuple, Locale locale, String format, int maxNumLeadingElements, int maxNumTrailingElements) Returns a string representation of the given tuple.
static double	variance(DoubleTuple t) Returns the variance of the given tuple.
static double	variance(DoubleTuple t, double mean) Returns the variance of the given tuple.
static MutableDoubleTuple	wrap(double... values) Creates a new tuple that is a view on the given values.
static MutableDoubleTuple	wrap(double[] data, int offset, int size) Returns a new tuple that is a view on the specified portion of the given array
static MutableDoubleTuple	wrap(DoubleBuffer buffer) Returns a new tuple that is a view on the given buffer.
static DoubleTuple	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 DoubleTuple 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 DoubleTuple constant(int size,
                                   double 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 MutableDoubleTuple 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 MutableDoubleTuple copy(DoubleTuple 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 MutableDoubleTuple of(double... 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(double...) may be used.

Parameters:

values - The values

Returns:

The new tuple

Throws:

NullPointerException - If the given array is null

wrap

public static MutableDoubleTuple wrap(double... 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 MutableDoubleTuple wrap(DoubleBuffer 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 MutableDoubleTuple wrap(double[] 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 double[] toArray(DoubleTuple t)

Creates a new array from the contents of the given tuple

Parameters:

t - The tuple

Returns:

The array

asList

public static List<Double> asList(DoubleTuple 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<Double> asList(MutableDoubleTuple 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(MutableDoubleTuple t,
                       double v)

Set all elements of the given tuple to the given value

Parameters:

t - The tuple

v - The value

reverse

public static MutableDoubleTuple reverse(DoubleTuple t,
                                         MutableDoubleTuple 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 DoubleTuple reversed(DoubleTuple 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 MutableDoubleTuple reversed(MutableDoubleTuple 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 MutableDoubleTuple clamp(DoubleTuple t,
                                       double min,
                                       double max,
                                       MutableDoubleTuple 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 MutableDoubleTuple clamp(DoubleTuple t,
                                       DoubleTuple min,
                                       DoubleTuple max,
                                       MutableDoubleTuple 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 MutableDoubleTuple negate(DoubleTuple t0,
                                        MutableDoubleTuple 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 MutableDoubleTuple add(DoubleTuple t0,
                                     DoubleTuple t1,
                                     MutableDoubleTuple 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 MutableDoubleTuple subtract(DoubleTuple t0,
                                          DoubleTuple t1,
                                          MutableDoubleTuple 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 MutableDoubleTuple multiply(DoubleTuple t0,
                                          DoubleTuple t1,
                                          MutableDoubleTuple 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 MutableDoubleTuple divide(DoubleTuple t0,
                                        DoubleTuple t1,
                                        MutableDoubleTuple 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 MutableDoubleTuple add(DoubleTuple t0,
                                     double value,
                                     MutableDoubleTuple 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 MutableDoubleTuple subtract(DoubleTuple t0,
                                          double value,
                                          MutableDoubleTuple 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 MutableDoubleTuple multiply(DoubleTuple t0,
                                          double factor,
                                          MutableDoubleTuple 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 MutableDoubleTuple addScaled(DoubleTuple t0,
                                           double factor,
                                           DoubleTuple t1,
                                           MutableDoubleTuple 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 double dot(DoubleTuple t0,
                         DoubleTuple 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 double min(DoubleTuple t)

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

Parameters:

t - The input tuple

Returns:

The minimum value

max

public static double max(DoubleTuple t)

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

Parameters:

t - The input tuple

Returns:

The maximum value

min

public static MutableDoubleTuple min(DoubleTuple t0,
                                     DoubleTuple t1,
                                     MutableDoubleTuple 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 MutableDoubleTuple max(DoubleTuple t0,
                                     DoubleTuple t1,
                                     MutableDoubleTuple 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(DoubleTuple t0,
                                           DoubleTuple 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(DoubleTuple t0,
                                             DoubleTuple 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<DoubleTuple> 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(DoubleTuple t0,
                                             DoubleTuple 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(DoubleTuple t0,
                                                    DoubleTuple 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(DoubleTuple t0,
                                          DoubleTuple 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(DoubleTuple t0,
                                                 DoubleTuple 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(DoubleTuple t,
                                             double 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(DoubleTuple t,
                                                    double 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(DoubleTuple t,
                                          double 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(DoubleTuple t,
                                                 double 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(DoubleTuple tuple,
                              int maxNumLeadingElements,
                              int maxNumTrailingElements)

Returns a string representation of the given tuple using toString(DoubleTuple, 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(DoubleTuple 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

randomize

public static void randomize(MutableDoubleTuple t,
                             double min,
                             double max,
                             Random random)

Fill the given tuple with random values in the specified range, using the given random number generator

Parameters:

t - The tuple to fill

min - The minimum value, inclusive

max - The maximum value, exclusive

random - The random number generator

randomize

public static void randomize(MutableDoubleTuple t,
                             Random random)

Fill the given tuple with random values in [0,1), using the given random number generator

Parameters:

t - The tuple to fill

random - The random number generator

createRandom

public static MutableDoubleTuple createRandom(int size,
                                              Random random)

Creates a tuple with the given size that is filled with random values in [0,1)

Parameters:

size - The size

random - The random number generator

Returns:

The new tuple

createRandom

public static MutableDoubleTuple createRandom(int size,
                                              double min,
                                              double max,
                                              Random random)

Creates a tuple with the given size that is filled with random values in the given range.

Parameters:

size - The size

min - The minimum value, inclusive

max - The maximum value, exclusive

random - The random number generator

Returns:

The new tuple

randomizeGaussian

public static void randomizeGaussian(MutableDoubleTuple t,
                                     Random random)

Randomize the given tuple with a gaussian distribution with a mean of 0.0 and standard deviation of 1.0

Parameters:

t - The tuple to fill

random - The random number generator

createRandomGaussian

public static MutableDoubleTuple createRandomGaussian(int size,
                                                      Random random)

Creates a tuple with the given size that was filled with values from a gaussian distribution with mean 0.0 and standard deviation 1.0

Parameters:

size - The size

random - The random number generator

Returns:

The new tuple

normalize

public static MutableDoubleTuple normalize(DoubleTuple t,
                                           MutableDoubleTuple result)

Normalize the given tuple and write the result into the given result tuple. That is, the given tuple is divided by its L2 norm.

Parameters:

t - The 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

computeL2

public static double computeL2(DoubleTuple t)

Computes the L2 norm (euclidean length) of the given tuple

Parameters:

t - The tuple

Returns:

The L2 norm

normalizeElements

public static MutableDoubleTuple normalizeElements(DoubleTuple t,
                                                   double min,
                                                   double max,
                                                   MutableDoubleTuple result)

Normalize the elements of the given tuple, so that its minimum and maximum elements match the given minimum and maximum values.

Parameters:

t - The input tuple

min - The minimum value

max - The maximum value

result - The tuple that will store the result

Returns:

The result tuple

Throws:

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

normalizeElements

public static MutableDoubleTuple normalizeElements(DoubleTuple t,
                                                   DoubleTuple min,
                                                   DoubleTuple max,
                                                   MutableDoubleTuple result)

Normalize the elements of the given tuple, so that each element will be linearly rescaled to the interval defined by the corresponding elements of the given minimum and maximum tuple. Each element that is equal to the corresponding minimum element will be 0.0 in the resulting tuple. Each element that is equal to the corresponding maximum element will be 1.0 in the resulting tuple. Other values will be interpolated accordingly.

Parameters:

t - The input tuple

min - The minimum value

max - The maximum value

result - The tuple that will store the result

Returns:

The result tuple

Throws:

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

rescaleElements

public static MutableDoubleTuple rescaleElements(DoubleTuple t,
                                                 double oldMin,
                                                 double oldMax,
                                                 double newMin,
                                                 double newMax,
                                                 MutableDoubleTuple result)

Rescale the elements of the given tuple, so that the specified old range is mapped to the specified new range.

Parameters:

t - The input tuple

oldMin - The old minimum value

oldMax - The old maximum value

newMin - The new minimum value

newMax - The new maximum value

result - The tuple that will store the result

Returns:

The result tuple

Throws:

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

interpolate

public static MutableDoubleTuple interpolate(DoubleTuple t0,
                                             DoubleTuple t1,
                                             double alpha,
                                             MutableDoubleTuple result)

Computes t0+alpha*(t1-t0), and stores the result in the given result tuple.

Parameters:

t0 - The first input tuple

t1 - The second input tuple

alpha - The interpolation value

result - The tuple that will store the result

Returns:

The result tuple

Throws:

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

standardDeviationFromVariance

public static MutableDoubleTuple standardDeviationFromVariance(DoubleTuple variance,
                                                               MutableDoubleTuple result)

Returns the standard deviation of the given variances (that is, a tuple containing the square roots of the values in the given tuple).

Parameters:

variance - The input tuple

result - The result tuple

Returns:

The standard deviation

Throws:

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

standardize

public static MutableDoubleTuple standardize(DoubleTuple t,
                                             MutableDoubleTuple result)

Standardize the given tuple. This means that the mean of the elements is subtracted from them, and they are divided by the standard deviation.

Parameters:

t - The tuple

result - The result tuple

Returns:

The result tuple

Throws:

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

arithmeticMean

public static double arithmeticMean(DoubleTuple t)

Returns the arithmetic mean of the given tuple

Parameters:

t - The input tuple

Returns:

The mean

variance

public static double variance(DoubleTuple t)

Returns the variance of the given tuple. The method will compute the arithmetic mean, and then compute the actual result with the variance(DoubleTuple, double) method.

Parameters:

t - The input tuple

Returns:

The variance

See Also:

variance(DoubleTuple, double)

variance

public static double variance(DoubleTuple t,
                              double mean)

Returns the variance of the given tuple.

Parameters:

t - The input tuple

mean - The mean, which may have been computed before with arithmeticMean(DoubleTuple)

Returns:

The variance

standardDeviation

public static double standardDeviation(DoubleTuple t)

Returns the standard deviation of the given tuple. The method will compute the arithmetic mean, and then compute the actual result with the standardDeviationFromMean(DoubleTuple, double) method.

Parameters:

t - The input tuple

Returns:

The standard deviation

standardDeviationFromMean

public static double standardDeviationFromMean(DoubleTuple t,
                                               double mean)

Returns the standard deviation of the given tuple. The method will compute variance(DoubleTuple), return the square root of this value.

Parameters:

t - The input tuple

mean - The mean, which may have been computed before with arithmeticMean(DoubleTuple)

Returns:

The standard deviation

containsNaN

public static boolean containsNaN(DoubleTuple tuple)

Returns whether the given tuple contains an element that is Not A Number

Parameters:

tuple - The tuple

Returns:

Whether the tuple contains a NaN element