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

Class InvertedDistanceSimilarityFunction<O>

java.lang.Object

de.lmu.ifi.dbs.elki.distance.similarityfunction.AbstractPrimitiveSimilarityFunction<O,DoubleDistance>

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

Type Parameters:

O - Object type

All Implemented Interfaces:

PrimitiveSimilarityFunction<O,DoubleDistance>, SimilarityFunction<O,DoubleDistance>, InspectionUtilFrequentlyScanned, Parameterizable

public class InvertedDistanceSimilarityFunction<O>
extends AbstractPrimitiveSimilarityFunction<O,DoubleDistance>

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

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,? extends NumberDistance<?,?>>	distanceFunction Holds the similarity function.

Constructor Summary

Constructors

Constructor and Description
InvertedDistanceSimilarityFunction()

Method Summary

Methods

Modifier and Type	Method and Description
DoubleDistance	getDistanceFactory() Get a distance factory.
SimpleTypeInformation<? super O>	getInputTypeRestriction() Get the input data type of the function.
DoubleDistance	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.similarityfunction.AbstractPrimitiveSimilarityFunction

instantiate, isSymmetric

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 .

Key: -adapter.distancefunction

Default value: EuclideanDistanceFunction

distanceFunction

protected PrimitiveDistanceFunction<? super O,? extends NumberDistance<?,?>> distanceFunction

Holds the similarity function.

Constructor Detail

InvertedDistanceSimilarityFunction

public InvertedDistanceSimilarityFunction()

Method Detail

getDistanceFactory

public DoubleDistance getDistanceFactory()

Description copied from interface: SimilarityFunction

Get a distance factory.

Returns:

distance factory

getInputTypeRestriction

public SimpleTypeInformation<? super O> getInputTypeRestriction()

Description copied from interface: SimilarityFunction

Get the input data type of the function.

Specified by:

getInputTypeRestriction in interface PrimitiveSimilarityFunction<O,DoubleDistance>

Specified by:

getInputTypeRestriction in interface SimilarityFunction<O,DoubleDistance>

Specified by:

getInputTypeRestriction in class AbstractPrimitiveSimilarityFunction<O,DoubleDistance>

similarity

public DoubleDistance 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,DoubleDistance>

Specified by:

similarity in class AbstractPrimitiveSimilarityFunction<O,DoubleDistance>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the similarity between two given DatabaseObjects according to this similarity function