Package us.ihmc.euclid.tools

Class TupleTools

java.lang.Object

us.ihmc.euclid.tools.TupleTools

public abstract class TupleTools
extends java.lang.Object

Tools for generic operations on tuples.

Author:

Sylvain Bertrand

Constructor Summary

Constructors

Constructor	Description
TupleTools()

Method Summary

Modifier and Type	Method	Description
static boolean	epsilonEquals(Tuple2DReadOnly tuple1, Tuple2DReadOnly tuple2, double epsilon)	Tests on a per component basis if the two given tuples are equal to an epsilon.
static boolean	epsilonEquals(Tuple3DReadOnly tuple1, Tuple3DReadOnly tuple2, double epsilon)	Tests on a per component basis if the two given tuples are equal to an epsilon.
static boolean	epsilonEquals(Tuple4DReadOnly tuple1, Tuple4DReadOnly tuple2, double epsilon)	Tests on a per component basis if the two given tuples are equal to an epsilon.
static double	interpolate(double a, double b, double alpha)	Deprecated. Use EuclidCoreTools.interpolate(double,double,double) instead

Methods inherited from class java.lang.Object

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

Constructor Detail

TupleTools

public TupleTools()

Method Detail

epsilonEquals

public static boolean epsilonEquals(Tuple2DReadOnly tuple1,
                                    Tuple2DReadOnly tuple2,
                                    double epsilon)

Tests on a per component basis if the two given tuples are equal to an epsilon.

Parameters:

tuple1 - the first tuple. Not modified.

tuple2 - the second tuple. Not modified.

epsilon - the tolerance to use when comparing each component.

Returns:

true if the two tuples are equal, false otherwise.

epsilonEquals

public static boolean epsilonEquals(Tuple3DReadOnly tuple1,
                                    Tuple3DReadOnly tuple2,
                                    double epsilon)

Tests on a per component basis if the two given tuples are equal to an epsilon.

Parameters:

tuple1 - the first tuple. Not modified.

tuple2 - the second tuple. Not modified.

epsilon - the tolerance to use when comparing each component.

Returns:

true if the two tuples are equal, false otherwise.

epsilonEquals

public static boolean epsilonEquals(Tuple4DReadOnly tuple1,
                                    Tuple4DReadOnly tuple2,
                                    double epsilon)

Tests on a per component basis if the two given tuples are equal to an epsilon.

Parameters:

tuple1 - the first tuple. Not modified.

tuple2 - the second tuple. Not modified.

epsilon - the tolerance to use when comparing each component.

Returns:

true if the two tuples are equal, false otherwise.

interpolate

@Deprecated
public static double interpolate(double a,
                                 double b,
                                 double alpha)

Deprecated.

Use EuclidCoreTools.interpolate(double,double,double) instead

Performs a linear interpolation from a to b given the percentage alpha.

result = (1.0 - alpha) * a + alpha * b

Parameters:

a - the first value used in the interpolation.

b - the second value used in the interpolation.

alpha - the percentage to use for the interpolation. A value of 0 will return a, while a value of 1 will return b.

Returns:

the interpolated value.