de.javagl.nd.distance.tuples.d

Class DoubleTupleDistanceFunctions

java.lang.Object

de.javagl.nd.distance.tuples.d.DoubleTupleDistanceFunctions

public class DoubleTupleDistanceFunctions
extends Object

Methods to create DistanceFunction instances for DoubleTuples

Method Summary

Modifier and Type	Method and Description
static DistanceFunction<DoubleTuple>	angular() Returns a DistanceFunction that computes the angular distance (that is, 1-c, where c is the cosine similarity)
static Comparator<DoubleTuple>	byDistanceComparator(DoubleTuple reference, java.util.function.ToDoubleBiFunction<? super DoubleTuple,? super DoubleTuple> distanceFunction) Returns a new comparator that compares DoubleTuple instances by their distance to the given reference, according to the given distance function.
static double	computeEuclidean(DoubleTuple t0, DoubleTuple t1) Computes the Euclidean distance between the given tuples
static double	computeEuclideanSquared(DoubleTuple t0, DoubleTuple t1) Computes the squared Euclidean distance between the given tuples
static DistanceFunction<DoubleTuple>	dynamicTimeWarping() Returns a DistanceFunction that computes the dynamic time warping distance between two DoubleTuples
static DistanceFunction<DoubleTuple>	euclidean() Returns a DistanceFunction that computes the Euclidean distance
static DistanceFunction<DoubleTuple>	euclideanSquared() Returns a DistanceFunction that computes the squared Euclidean distance

Methods inherited from class java.lang.Object

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

Method Detail

byDistanceComparator

public static Comparator<DoubleTuple> byDistanceComparator(DoubleTuple reference,
                                                           java.util.function.ToDoubleBiFunction<? super DoubleTuple,? super DoubleTuple> distanceFunction)

Returns a new comparator that compares DoubleTuple instances by their distance to the given reference, according to the given distance function. A copy of the given reference point will be stored, so that changes in the given point will not affect the returned comparator.

Parameters:

reference - The reference point

distanceFunction - The distance function

Returns:

The comparator

euclidean

public static DistanceFunction<DoubleTuple> euclidean()

Returns a DistanceFunction that computes the Euclidean distance

Returns:

The DistanceFunction

euclideanSquared

public static DistanceFunction<DoubleTuple> euclideanSquared()

Returns a DistanceFunction that computes the squared Euclidean distance

Returns:

The DistanceFunction

computeEuclidean

public static double computeEuclidean(DoubleTuple t0,
                                      DoubleTuple t1)

Computes the Euclidean distance between the given tuples

Parameters:

t0 - The first tuple

t1 - The second tuple

Returns:

The distance

Throws:

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

computeEuclideanSquared

public static double computeEuclideanSquared(DoubleTuple t0,
                                             DoubleTuple t1)

Computes the squared Euclidean distance between the given tuples

Parameters:

t0 - The first tuple

t1 - The second tuple

Returns:

The squared distance

Throws:

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

angular

public static DistanceFunction<DoubleTuple> angular()

Returns a DistanceFunction that computes the angular distance (that is, 1-c, where c is the cosine similarity)

Returns:

The DistanceFunction

dynamicTimeWarping

public static DistanceFunction<DoubleTuple> dynamicTimeWarping()

Returns a DistanceFunction that computes the dynamic time warping distance between two DoubleTuples

Returns:

The DistanceFunction