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

Class MatrixWeightedDistanceFunction

java.lang.Object

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

HSBHistogramQuadraticDistanceFunction, RGBHistogramQuadraticDistanceFunction

public class MatrixWeightedDistanceFunction
extends AbstractNumberVectorDistanceFunction

Weighted distance for feature vectors.

Since:

0.2

Author:

Elke Achtert

Field Summary

Fields

Modifier and Type	Field and Description
protected Matrix	weightMatrix The weight matrix.

Constructor Summary

Constructors

Constructor and Description
MatrixWeightedDistanceFunction(Matrix weightMatrix) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
double	distance(NumberVector o1, NumberVector o2) Computes the distance between two given DatabaseObjects according to this distance function.
VectorFieldTypeInformation<? super NumberVector>	getInputTypeRestriction() Get the input data type of the function.

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

dimensionality, dimensionality, dimensionality, dimensionality

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

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.DistanceFunction

instantiate, isMetric, isSymmetric

Field Detail

weightMatrix

protected Matrix weightMatrix

The weight matrix.

Constructor Detail

MatrixWeightedDistanceFunction

public MatrixWeightedDistanceFunction(Matrix weightMatrix)

Constructor.

Parameters:

weightMatrix - weight matrix

Method Detail

distance

public double distance(NumberVector o1,
              NumberVector o2)

Description copied from interface: PrimitiveDistanceFunction

Computes the distance between two given DatabaseObjects according to this distance function.

Specified by:

distance in interface NumberVectorDistanceFunction<NumberVector>

Specified by:

distance in interface PrimitiveDistanceFunction<NumberVector>

Specified by:

distance in class AbstractPrimitiveDistanceFunction<NumberVector>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

getInputTypeRestriction

public VectorFieldTypeInformation<? 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>

Overrides:

getInputTypeRestriction in class AbstractNumberVectorDistanceFunction

Returns:

Type restriction