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
 D getDistanceFactory()
          Method to get the distance functions factory.
 Relation<? extends O> getRelation()
          Access the underlying data query.
 D similarity(DBID id1, DBID id2)
          Returns the similarity between the two objects specified by their object ids.
 D similarity(DBID id1, O o2)
          Returns the similarity between the two objects specified by their object ids.
 D similarity(O o1, DBID 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(DBID id1,
             DBID 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,
             DBID 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(DBID 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

Release 0.4.0 (2011-09-20_1324)