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

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<O>
                      de.lmu.ifi.dbs.elki.distance.distancefunction.WeightedDistanceFunction<O>

All Implemented Interfaces:

DistanceFunction<O,DoubleDistance>, MeasurementFunction<O,DoubleDistance>, Loggable, Parameterizable

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

Provides the Weighted distance for feature vectors.

Author:

Elke Achtert todo weight matrix as parameter

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

Constructor Summary

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

Method Summary

String	description() Returns a description of the class and the required parameters.
DoubleDistance	distance(O o1, O o2) Provides the Weighted distance for feature vectors.

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, checkGlobalParameterConstraints, deleteOption, description, description, getAttributeSettings, getParameters, getParameterValue, getPossibleOptions, inlineDescription, isSet, setParameters, setParameters

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

debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, 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, getAttributeSettings, getParameters, getPossibleOptions, inlineDescription, setParameters

Field Detail

weightMatrix

private Matrix weightMatrix

The weight matrix.

Constructor Detail

WeightedDistanceFunction

public WeightedDistanceFunction(Matrix weightMatrix)

Provides the Weighted distance for feature vectors.

Method Detail

distance

public DoubleDistance distance(O o1,
                               O 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.

See Also:

DistanceFunction.distance(de.lmu.ifi.dbs.elki.data.DatabaseObject, de.lmu.ifi.dbs.elki.data.DatabaseObject)

description

public String description()

Description copied from interface: Parameterizable

Returns a description of the class and the required parameters.

This description should be suitable for a usage description as for a standalone application.

Specified by:

description in interface Parameterizable

Overrides:

description in class AbstractParameterizable

Returns:

String a description of the class and the required parameters

See Also:

todo: parameters required