de.lmu.ifi.dbs.elki.distance.similarityfunction
Class AbstractSimilarityFunction<O extends DatabaseObject,D extends Distance<D>>

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction<O,D>
          de.lmu.ifi.dbs.elki.distance.similarityfunction.AbstractSimilarityFunction<O,D>

Type Parameters:

O - object type

D - distance type

All Implemented Interfaces:

MeasurementFunction<O,D>, SimilarityFunction<O,D>, Parameterizable

Direct Known Subclasses:

AbstractPreprocessorBasedSimilarityFunction

public abstract class AbstractSimilarityFunction<O extends DatabaseObject,D extends Distance<D>>
extends AbstractMeasurementFunction<O,D>
implements SimilarityFunction<O,D>

Author:

Arthur Zimek

Field Summary

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

distanceFactory

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

debug, logger

Constructor Summary

protected

AbstractSimilarityFunction(D distance)

Method Summary

D	similarity(Integer id1, O o2) Returns the similarity between the two specified objects.
D	similarity(O o1, O o2) Computes the similarity between two given DatabaseObjects according to this similarity function.

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

getDatabase, getDistanceFactory, infiniteDistance, nullDistance, setDatabase, undefinedDistance, valueOf

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.similarityfunction.SimilarityFunction

similarity

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.MeasurementFunction

getDistanceFactory, infiniteDistance, nullDistance, setDatabase, undefinedDistance, valueOf

Constructor Detail

AbstractSimilarityFunction

protected AbstractSimilarityFunction(D distance)

Method Detail

similarity

public D similarity(Integer id1,
                    O o2)

Description copied from interface: SimilarityFunction

Returns the similarity between the two specified objects.

Specified by:

similarity in interface SimilarityFunction<O extends DatabaseObject,D extends Distance<D>>

Parameters:

id1 - first object id

o2 - second DatabaseObject

Returns:

the similarity between the two objects specified by their object ids

similarity

public D similarity(O o1,
                    O o2)

Description copied from interface: SimilarityFunction

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

Specified by:

similarity in interface SimilarityFunction<O extends DatabaseObject,D extends Distance<D>>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the similarity between two given DatabaseObjects according to this similarity function