de.javagl.nd.distance.tuples.i

Class IntTupleDistanceFunctions

java.lang.Object

de.javagl.nd.distance.tuples.i.IntTupleDistanceFunctions

public class IntTupleDistanceFunctions
extends Object

Methods to create DistanceFunctions for IntTuples

Method Summary

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

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

Returns a DistanceFunction that computes the Euclidean distance

Returns:

The DistanceFunction

euclideanSquared

public static DistanceFunction<IntTuple> euclideanSquared()

Returns a DistanceFunction that computes the squared Euclidean distance

Returns:

The DistanceFunction

wrappedEuclidean

public static DistanceFunction<IntTuple> wrappedEuclidean(IntTuple size)

Returns a DistanceFunction that computes the Euclidean distance of IntTuples 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<IntTuple> wrappedEuclideanSquared(IntTuple size)

Returns a DistanceFunction that computes the squared Euclidean distance of IntTuples 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<IntTuple> manhattan()

Returns a DistanceFunction that computes the Manhattan distance

Returns:

The DistanceFunction

wrappedManhattan

public static DistanceFunction<IntTuple> wrappedManhattan(IntTuple size)

Returns a DistanceFunction that computes the Manhattan distance of IntTuples 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<IntTuple> chebyshev()

Returns a DistanceFunction that computes the Chebyshev distance

Returns:

The DistanceFunction

wrappedChebyshev

public static DistanceFunction<IntTuple> wrappedChebyshev(IntTuple size)

Returns a DistanceFunction that computes the Chebyshev distance of IntTuples 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