de.lmu.ifi.dbs.elki.distance.distancefunction
Class WeightedDistanceFunction<V extends NumberVector<V,?>>

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
          de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction<O,D>
              de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDistanceFunction<O,DoubleDistance>
                  de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDoubleDistanceFunction<V>
                      de.lmu.ifi.dbs.elki.distance.distancefunction.WeightedDistanceFunction<V>

Type Parameters:

V - the type of NumberVector to compute the distances in between

All Implemented Interfaces:

DistanceFunction<V,DoubleDistance>, MeasurementFunction<V,DoubleDistance>, Parameterizable

public class WeightedDistanceFunction<V extends NumberVector<V,?>>
extends AbstractDoubleDistanceFunction<V>

Provides the Weighted distance for feature vectors.

Author:

Elke Achtert

Field Summary

private Matrix

weightMatrix The weight matrix.

Fields inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction

INFINITY_PATTERN

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable

optionHandler

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug, logger

Constructor Summary

WeightedDistanceFunction(Matrix weightMatrix)
Provides the Weighted distance for feature vectors.

Method Summary

DoubleDistance	distance(V o1, V o2) Provides the Weighted distance for feature vectors.
String	shortDescription() Returns the required input pattern.

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

infiniteDistance, nullDistance, undefinedDistance, valueOf

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

distance, distance, isInfiniteDistance, isNullDistance, isUndefinedDistance

Methods inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction

getDatabase, matches, requiredInputPattern, setDatabase, setRequiredInputPattern

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable

addOption, addParameterizable, addParameterizable, checkGlobalParameterConstraints, collectOptions, getAttributeSettings, getParameters, rememberParametersExcept, removeOption, removeParameterizable, setParameters

Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, progress, verbose, warning

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

requiredInputPattern, setDatabase

Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable

checkGlobalParameterConstraints, collectOptions, getParameters, setParameters

Field Detail

weightMatrix

private Matrix weightMatrix

The weight matrix.

Constructor Detail

WeightedDistanceFunction

public WeightedDistanceFunction(Matrix weightMatrix)

Provides the Weighted distance for feature vectors.

Parameters:

weightMatrix - weight matrix

Method Detail

distance

public DoubleDistance distance(V o1,
                               V o2)

Provides the Weighted distance for feature vectors.

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the Weighted distance between the given two vectors as an instance of DoubleDistance.

shortDescription

public String shortDescription()

Description copied from class: AbstractMeasurementFunction

Returns the required input pattern.

Specified by:

shortDescription in interface Parameterizable

Overrides:

shortDescription in class AbstractMeasurementFunction<V extends NumberVector<V,?>,DoubleDistance>

Returns:

Description of the class