Package kieker.analysis.generic.clustering.mtree

Class DistanceFunctionFactory

java.lang.Object

kieker.analysis.generic.clustering.mtree.DistanceFunctionFactory

public final class DistanceFunctionFactory
extends Object

Some pre-defined implementations of distance functions.

Since:

2.0.0

Author:

Eduardo R. D'Avila

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DistanceFunctionFactory.IEuclideanCoordinate	An interface to represent coordinates in Euclidean spaces.

Field Summary

Fields

Modifier and Type	Field	Description
static final IDistanceFunction<DistanceFunctionFactory.IEuclideanCoordinate>	EUCLIDEAN	A distance function object that calculates the distance between two euclidean coordinates.
static final IDistanceFunction<List<Double>>	EUCLIDEAN_DOUBLE_LIST	A distance function object that calculates the distance between two coordinates represented by lists of Doubles.
static final IDistanceFunction<List<Integer>>	EUCLIDEAN_INTEGER_LIST	A distance function object that calculates the distance between two coordinates represented by lists of Integers.

Method Summary

Modifier and Type	Method	Description
static <D> IDistanceFunction<D>	cached(IDistanceFunction<D> distanceFunction)	Creates a cached version of a distance function.
static double	euclidean(DistanceFunctionFactory.IEuclideanCoordinate coord1, DistanceFunctionFactory.IEuclideanCoordinate coord2)	Calculates the distance between two euclidean coordinates.

Methods inherited from class java.lang.Object

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

Field Details

EUCLIDEAN

public static final IDistanceFunction<DistanceFunctionFactory.IEuclideanCoordinate> EUCLIDEAN

A distance function object that calculates the distance between two euclidean coordinates.

EUCLIDEAN_INTEGER_LIST

public static final IDistanceFunction<List<Integer>> EUCLIDEAN_INTEGER_LIST

A distance function object that calculates the distance between two coordinates represented by lists of Integers.

EUCLIDEAN_DOUBLE_LIST

public static final IDistanceFunction<List<Double>> EUCLIDEAN_DOUBLE_LIST

A distance function object that calculates the distance between two coordinates represented by lists of Doubles.

Method Details

cached

public static <D> IDistanceFunction<D> cached(IDistanceFunction<D> distanceFunction)

Creates a cached version of a distance function. This method is used internally by MTree to create a cached distance function to pass to the split function.

Type Parameters:

D - distance function type

Parameters:

distanceFunction - The distance function to create a cached version of.

Returns:

The cached distance function.

euclidean

public static double euclidean(DistanceFunctionFactory.IEuclideanCoordinate coord1,
 DistanceFunctionFactory.IEuclideanCoordinate coord2)

Calculates the distance between two euclidean coordinates.

Parameters:

coord1 - first coordinate

coord2 - second coordinate

Returns:

returns the distance value