de.lmu.ifi.dbs.elki.distance.distancefunction

Class AbstractNumberVectorDistanceFunction

java.lang.Object

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractPrimitiveDistanceFunction<NumberVector>

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractNumberVectorDistanceFunction

All Implemented Interfaces:

DistanceFunction<NumberVector>, NumberVectorDistanceFunction<NumberVector>, PrimitiveDistanceFunction<NumberVector>

Direct Known Subclasses:

AbsolutePearsonCorrelationDistanceFunction, AbsoluteUncenteredCorrelationDistanceFunction, AbstractEditDistanceFunction, AbstractNumberVectorNorm, AbstractSpatialDistanceFunction, HellingerDistanceFunction, KolmogorovSmirnovDistanceFunction, KullbackLeiblerDivergenceAsymmetricDistanceFunction, KullbackLeiblerDivergenceReverseAsymmetricDistanceFunction, LCSSDistanceFunction, MatrixWeightedDistanceFunction, MultiLPNorm, PearsonCorrelationDistanceFunction, SqrtJensenShannonDivergenceDistanceFunction, SquaredPearsonCorrelationDistanceFunction, SquaredUncenteredCorrelationDistanceFunction, TutorialDistanceFunction, UncenteredCorrelationDistanceFunction, WeightedPearsonCorrelationDistanceFunction, WeightedSquaredPearsonCorrelationDistanceFunction

public abstract class AbstractNumberVectorDistanceFunction
extends AbstractPrimitiveDistanceFunction<NumberVector>
implements NumberVectorDistanceFunction<NumberVector>

Abstract base class for the most common family of distance functions: defined on number vectors and returning double values.

Author:

Erich Schubert

Constructor Summary

Constructors

Constructor and Description
AbstractNumberVectorDistanceFunction() Constructor.

Method Summary

Modifier and Type	Method and Description
static int	dimensionality(NumberVector o1, NumberVector o2) Get the common dimensionality of the two objects.
static int	dimensionality(NumberVector o1, NumberVector o2, int expect) Get the common dimensionality of the two objects.
static int	dimensionality(SpatialComparable o1, SpatialComparable o2) Get the common dimensionality of the two objects.
static int	dimensionality(SpatialComparable o1, SpatialComparable o2, int expect) Get the common dimensionality of the two objects.
SimpleTypeInformation<? super NumberVector>	getInputTypeRestriction() Get the input data type of the function.

Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractPrimitiveDistanceFunction

distance, instantiate, isMetric, isSymmetric

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.NumberVectorDistanceFunction

distance

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.PrimitiveDistanceFunction

distance

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.DistanceFunction

instantiate, isMetric, isSymmetric

Constructor Detail

AbstractNumberVectorDistanceFunction

public AbstractNumberVectorDistanceFunction()

Constructor.

Method Detail

getInputTypeRestriction

public SimpleTypeInformation<? super NumberVector> getInputTypeRestriction()

Description copied from interface: DistanceFunction

Get the input data type of the function.

Specified by:

getInputTypeRestriction in interface DistanceFunction<NumberVector>

Specified by:

getInputTypeRestriction in interface PrimitiveDistanceFunction<NumberVector>

Returns:

Type restriction

dimensionality

public static final int dimensionality(SpatialComparable o1,
                                       SpatialComparable o2)

Get the common dimensionality of the two objects. Throw an IllegalArgumentException otherwise.

Parameters:

o1 - First vector / MBR

o2 - Second vector / MBR

Returns:

Common dimensionality

Throws:

IllegalArgumentException - when dimensionalities are not the same.

dimensionality

public static final int dimensionality(SpatialComparable o1,
                                       SpatialComparable o2,
                                       int expect)

Get the common dimensionality of the two objects. Throw an IllegalArgumentException otherwise.

Parameters:

o1 - First vector / MBR

o2 - Second vector / MBR

expect - Expected dimensionality

Returns:

Common dimensionality

Throws:

IllegalArgumentException - when dimensionalities are not the same.

dimensionality

public static final int dimensionality(NumberVector o1,
                                       NumberVector o2)

Get the common dimensionality of the two objects. Throw an IllegalArgumentException otherwise.

Parameters:

o1 - First vector / MBR

o2 - Second vector / MBR

Returns:

Common dimensionality

Throws:

IllegalArgumentException - when dimensionalities are not the same.

dimensionality

public static final int dimensionality(NumberVector o1,
                                       NumberVector o2,
                                       int expect)

Get the common dimensionality of the two objects. Throw an IllegalArgumentException otherwise.

Parameters:

o1 - First vector / MBR

o2 - Second vector / MBR

expect - Expected dimensionality

Returns:

Common dimensionality

Throws:

IllegalArgumentException - when dimensionalities are not the same.