de.lmu.ifi.dbs.elki.distance.distancefunction.adapter
Class SimilarityAdapterLn<V extends FeatureVector<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.adapter.SimilarityAdapterAbstract<V>
                          de.lmu.ifi.dbs.elki.distance.distancefunction.adapter.SimilarityAdapterLn<V>

Type Parameters:

V - Vector class to process.

All Implemented Interfaces:

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

public class SimilarityAdapterLn<V extends FeatureVector<V,?>>
extends SimilarityAdapterAbstract<V>

Adapter from a normalized similarity function to a distance function using -log(sim).

Author:

Erich Schubert

Field Summary

Fields inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.adapter.SimilarityAdapterAbstract

SIMILARITY_FUNCTION_ID, SIMILARITY_FUNCTION_PARAM, similarityFunction

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

SimilarityAdapterLn()

Method Summary

DoubleDistance

distance(V v1, V v2) Distance implementation

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

setDatabase, setParameters, shortDescription

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, setRequiredInputPattern

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

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

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

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

checkGlobalParameterConstraints, collectOptions, getParameters

Constructor Detail

SimilarityAdapterLn

public SimilarityAdapterLn()

Method Detail

distance

public DoubleDistance distance(V v1,
                               V v2)

Distance implementation

Specified by:

distance in interface DistanceFunction<V extends FeatureVector<V,?>,DoubleDistance>

Specified by:

distance in class SimilarityAdapterAbstract<V extends FeatureVector<V,?>>

Parameters:

v1 - first DatabaseObject

v2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function