de.lmu.ifi.dbs.elki.distance.similarityfunction

Class InvertedDistanceSimilarityFunction<O>

java.lang.Object

de.lmu.ifi.dbs.elki.distance.similarityfunction.InvertedDistanceSimilarityFunction<O>

Type Parameters:

O - Object type

All Implemented Interfaces:

PrimitiveSimilarityFunction<O>, SimilarityFunction<O>

public class InvertedDistanceSimilarityFunction<O>
extends java.lang.Object
implements PrimitiveSimilarityFunction<O>

Adapter to use a primitive number-distance as similarity measure, by computing 1/distance.

Since:

0.5.0

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
static OptionID	DISTANCE_FUNCTION_ID Parameter to specify the similarity function to derive the distance between database objects from.
protected PrimitiveDistanceFunction<? super O>	distanceFunction Holds the similarity function.

Constructor Summary

Constructors

Constructor and Description
InvertedDistanceSimilarityFunction()

Method Summary

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

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

instantiate

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.similarityfunction.SimilarityFunction

isSymmetric

Field Detail

DISTANCE_FUNCTION_ID

public static final OptionID DISTANCE_FUNCTION_ID

Parameter to specify the similarity function to derive the distance between database objects from. Must extend DistanceFunction .

distanceFunction

protected PrimitiveDistanceFunction<? super O> distanceFunction

Holds the similarity function.

Constructor Detail

InvertedDistanceSimilarityFunction

public InvertedDistanceSimilarityFunction()

Method Detail

getInputTypeRestriction

public SimpleTypeInformation<? super O> getInputTypeRestriction()

Description copied from interface: SimilarityFunction

Get the input data type of the function.

Specified by:

getInputTypeRestriction in interface SimilarityFunction<O>

similarity

public double similarity(O o1,
                         O o2)

Description copied from interface: PrimitiveSimilarityFunction

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

Specified by:

similarity in interface PrimitiveSimilarityFunction<O>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the similarity between two given DatabaseObjects according to this similarity function