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

Class DBIDDistanceQuery

java.lang.Object

de.lmu.ifi.dbs.elki.database.query.distance.DBIDDistanceQuery

All Implemented Interfaces:

DatabaseQuery, DatabaseDistanceQuery<DBID>, DistanceQuery<DBID>

Direct Known Subclasses:

DBIDRangeDistanceQuery

public class DBIDDistanceQuery
extends java.lang.Object
implements DatabaseDistanceQuery<DBID>

Run a distance query based on DBIDs

Since:

0.4.0

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
protected DBIDDistanceFunction	distanceFunction The distance function we use.
protected Relation<DBID>	relation Relation to query.

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

Constructor Summary

Constructors

Constructor and Description
DBIDDistanceQuery(Relation<DBID> relation, DBIDDistanceFunction distanceFunction) Constructor.

Method Summary

Modifier and Type	Method and Description
double	distance(DBIDRef id1, DBIDRef id2) Returns the distance between the two objects specified by their object ids.
DBIDDistanceFunction	getDistanceFunction() Get the inner distance function.
Relation<? extends DBID>	getRelation() Access the underlying data query.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.database.query.distance.DatabaseDistanceQuery

distance, distance, distance

Field Detail

relation

protected final Relation<DBID> relation

Relation to query.

distanceFunction

protected final DBIDDistanceFunction distanceFunction

The distance function we use.

Constructor Detail

DBIDDistanceQuery

public DBIDDistanceQuery(Relation<DBID> relation,
                         DBIDDistanceFunction distanceFunction)

Constructor.

Parameters:

relation - Database to use.

distanceFunction - Our distance function

Method Detail

distance

public double distance(DBIDRef id1,
                       DBIDRef id2)

Description copied from interface: DistanceQuery

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

Specified by:

distance in interface DistanceQuery<DBID>

Parameters:

id1 - first object id

id2 - second object id

Returns:

the distance between the two objects specified by their object ids

getRelation

public Relation<? extends DBID> getRelation()

Description copied from interface: DistanceQuery

Access the underlying data query.

Specified by:

getRelation in interface DistanceQuery<DBID>

Returns:

data query in use

getDistanceFunction

public DBIDDistanceFunction getDistanceFunction()

Description copied from interface: DistanceQuery

Get the inner distance function.

Specified by:

getDistanceFunction in interface DistanceQuery<DBID>

Returns:

Distance function