de.javagl.nd.distance.tuples.j

Class LongTupleDistanceFunctions

java.lang.Object

de.javagl.nd.distance.tuples.j.LongTupleDistanceFunctions

public class LongTupleDistanceFunctions
extends Object

Methods to create DistanceFunctions for LongTuples

Method Summary

Modifier and Type	Method and Description
static Comparator<LongTuple>	byDistanceComparator(LongTuple reference, java.util.function.ToDoubleBiFunction<? super LongTuple,? super LongTuple> distanceFunction) Returns a new comparator that compares LongTuple instances by their distance to the given reference, according to the given distance function.
static DistanceFunction<LongTuple>	chebyshev() Returns a DistanceFunction that computes the Chebyshev distance
static DistanceFunction<LongTuple>	euclidean() Returns a DistanceFunction that computes the Euclidean distance
static DistanceFunction<LongTuple>	euclideanSquared() Returns a DistanceFunction that computes the squared Euclidean distance
static DistanceFunction<LongTuple>	manhattan() Returns a DistanceFunction that computes the Manhattan distance
static DistanceFunction<LongTuple>	wrappedChebyshev(LongTuple size) Returns a DistanceFunction that computes the Chebyshev distance of LongTuples when they are interpreted as points on a sphere with the given size (that is, circumference).
static DistanceFunction<LongTuple>	wrappedEuclidean(LongTuple size) Returns a DistanceFunction that computes the Euclidean distance of LongTuples when they are interpreted as points on a sphere with the given size (that is, circumference).
static DistanceFunction<LongTuple>	wrappedEuclideanSquared(LongTuple size) Returns a DistanceFunction that computes the squared Euclidean distance of LongTuples when they are interpreted as points on a sphere with the given size (that is, circumference).
static DistanceFunction<LongTuple>	wrappedManhattan(LongTuple size) Returns a DistanceFunction that computes the Manhattan distance of LongTuples when they are interpreted as points on a sphere with the given size (that is, circumference).

Methods inherited from class java.lang.Object

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

Method Detail

byDistanceComparator

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

Returns a new comparator that compares LongTuple 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<LongTuple> euclidean()

Returns a DistanceFunction that computes the Euclidean distance

Returns:

The DistanceFunction

euclideanSquared

public static DistanceFunction<LongTuple> euclideanSquared()

Returns a DistanceFunction that computes the squared Euclidean distance

Returns:

The DistanceFunction

wrappedEuclidean

public static DistanceFunction<LongTuple> wrappedEuclidean(LongTuple size)

Returns a DistanceFunction that computes the Euclidean distance of LongTuples when they are interpreted as points on a sphere with the given size (that is, circumference).

Parameters:

size - The size of the sphere

Returns:

The DistanceFunction

wrappedEuclideanSquared

public static DistanceFunction<LongTuple> wrappedEuclideanSquared(LongTuple size)

Returns a DistanceFunction that computes the squared Euclidean distance of LongTuples when they are interpreted as points on a sphere with the given size (that is, circumference).

Parameters:

size - The size of the sphere

Returns:

The DistanceFunction

manhattan

public static DistanceFunction<LongTuple> manhattan()

Returns a DistanceFunction that computes the Manhattan distance

Returns:

The DistanceFunction

wrappedManhattan

public static DistanceFunction<LongTuple> wrappedManhattan(LongTuple size)

Returns a DistanceFunction that computes the Manhattan distance of LongTuples when they are interpreted as points on a sphere with the given size (that is, circumference).

Parameters:

size - The size of the sphere

Returns:

The DistanceFunction

chebyshev

public static DistanceFunction<LongTuple> chebyshev()

Returns a DistanceFunction that computes the Chebyshev distance

Returns:

The DistanceFunction

wrappedChebyshev

public static DistanceFunction<LongTuple> wrappedChebyshev(LongTuple size)

Returns a DistanceFunction that computes the Chebyshev distance of LongTuples when they are interpreted as points on a sphere with the given size (that is, circumference).

Parameters:

size - The size of the sphere

Returns:

The DistanceFunction