de.lmu.ifi.dbs.elki.database.query.similarity

Interface SimilarityQuery<O,D extends Distance<?>>

All Superinterfaces:

DatabaseQuery

All Known Subinterfaces:

DistanceSimilarityQuery<O,D>, IndexBasedSimilarityFunction.Instance<T,I,D>

All Known Implementing Classes:

AbstractDBIDSimilarityQuery, AbstractIndexBasedSimilarityFunction.Instance, AbstractSimilarityQuery, FractionalSharedNearestNeighborSimilarityFunction.Instance, PrimitiveDistanceSimilarityQuery, PrimitiveSimilarityQuery, SharedNearestNeighborSimilarityFunction.Instance

public interface SimilarityQuery<O,D extends Distance<?>>
extends DatabaseQuery

A similarity query serves as adapter layer for database and primitive similarity functions.

Field Summary

Fields inherited from interface de.lmu.ifi.dbs.elki.database.query.DatabaseQuery

HINT_BULK, HINT_EXACT, HINT_HEAVY_USE, HINT_NO_CACHE, HINT_OPTIMIZED_ONLY, HINT_SINGLE

Method Summary

Methods

Modifier and Type	Method and Description
D	getDistanceFactory() Method to get the distance functions factory.
Relation<? extends O>	getRelation() Access the underlying data query.
SimilarityFunction<? super O,D>	getSimilarityFunction() Get the inner similarity function.
D	similarity(DBIDRef id1, DBIDRef id2) Returns the similarity between the two objects specified by their object ids.
D	similarity(DBIDRef id1, O o2) Returns the similarity between the two objects specified by their object ids.
D	similarity(O o1, DBIDRef id2) Returns the similarity between the two objects specified by their object ids.
D	similarity(O o1, O o2) Returns the similarity between the two objects specified by their object ids.

Method Detail

similarity

D similarity(DBIDRef id1,
           DBIDRef id2)

Returns the similarity between the two objects specified by their object ids.

Parameters:

id1 - first object id

id2 - second object id

Returns:

the similarity between the two objects specified by their object ids

similarity

D similarity(O o1,
           DBIDRef id2)

Returns the similarity between the two objects specified by their object ids.

Parameters:

o1 - first object

id2 - second object id

Returns:

the similarity between the two objects specified by their object ids

similarity

D similarity(DBIDRef id1,
           O o2)

Returns the similarity between the two objects specified by their object ids.

Parameters:

id1 - first object id

o2 - second object

Returns:

the similarity between the two objects specified by their object ids

similarity

D similarity(O o1,
           O o2)

Returns the similarity between the two objects specified by their object ids.

Parameters:

o1 - first object

o2 - second object

Returns:

the similarity between the two objects specified by their object ids

getDistanceFactory

D getDistanceFactory()

Method to get the distance functions factory.

Returns:

Factory for distance objects

getRelation

Relation<? extends O> getRelation()

Access the underlying data query.

Returns:

data query in use

getSimilarityFunction

SimilarityFunction<? super O,D> getSimilarityFunction()

Get the inner similarity function.

Returns:

Similarity function