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

Interface SimilarityQuery<O>

Type Parameters:

O - Input object type

All Superinterfaces:

DatabaseQuery

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractIndexBasedSimilarityFunction.Instance, FractionalSharedNearestNeighborSimilarityFunction.Instance, PrecomputedSimilarityMatrix.PrecomputedSimilarityQuery, PrimitiveDistanceSimilarityQuery, PrimitiveSimilarityQuery, SharedNearestNeighborSimilarityFunction.Instance, SpatialPrimitiveDistanceSimilarityQuery

public interface SimilarityQuery<O>
extends DatabaseQuery

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

Since:

0.4.0

Author:

Erich Schubert

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

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

Method Detail

similarity

double 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

double 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

double 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

double 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

getRelation

Relation<? extends O> getRelation()

Access the underlying data query.

Returns:

data query in use

getSimilarityFunction

SimilarityFunction<? super O> getSimilarityFunction()

Get the inner similarity function.

Returns:

Similarity function