de.lmu.ifi.dbs.elki.distance.distancefunction.adapter

Class AbstractSimilarityAdapter<O>

java.lang.Object

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDatabaseDistanceFunction<O>

de.lmu.ifi.dbs.elki.distance.distancefunction.adapter.AbstractSimilarityAdapter<O>

Type Parameters:

O - object class to process

All Implemented Interfaces:

DistanceFunction<O>

Direct Known Subclasses:

ArccosSimilarityAdapter, LinearAdapterLinear, LnSimilarityAdapter

public abstract class AbstractSimilarityAdapter<O>
extends AbstractDatabaseDistanceFunction<O>

Adapter from a similarity function to a distance function.

Note: The derived distance function will usually not satisfy the triangle equation.

Since:

0.2

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSimilarityAdapter.Instance<O> Inner proxy class for SNN distance function.
static class	AbstractSimilarityAdapter.Parameterizer<O,S extends SimilarityFunction<? super O>> Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
protected SimilarityFunction<? super O>	similarityFunction Holds the similarity function.

Constructor Summary

Constructors

Constructor and Description
AbstractSimilarityAdapter(SimilarityFunction<? super O> similarityFunction) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
TypeInformation	getInputTypeRestriction() Get the input data type of the function.
int	hashCode()
abstract <T extends O> DistanceQuery<T>	instantiate(Relation<T> database) Instantiate with a database to get the actual distance query.
boolean	isSymmetric() Is this function symmetric?

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

isMetric

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.DistanceFunction

isSquared

Field Detail

similarityFunction

protected SimilarityFunction<? super O> similarityFunction

Holds the similarity function.

Constructor Detail

AbstractSimilarityAdapter

public AbstractSimilarityAdapter(SimilarityFunction<? super O> similarityFunction)

Constructor.

Parameters:

similarityFunction - Similarity function to use.

Method Detail

getInputTypeRestriction

public TypeInformation getInputTypeRestriction()

Description copied from interface: DistanceFunction

Get the input data type of the function.

Returns:

Type restriction

isSymmetric

public boolean isSymmetric()

Description copied from interface: DistanceFunction

Is this function symmetric?

Specified by:

isSymmetric in interface DistanceFunction<O>

Overrides:

isSymmetric in class AbstractDatabaseDistanceFunction<O>

Returns:

true when symmetric

instantiate

public abstract <T extends O> DistanceQuery<T> instantiate(Relation<T> database)

Description copied from interface: DistanceFunction

Instantiate with a database to get the actual distance query.

Parameters:

database - The representation to use

Returns:

Actual distance query.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object