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

Class AbstractDBIDRangeDistanceFunction

java.lang.Object

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

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

All Implemented Interfaces:

DBIDDistanceFunction, DBIDRangeDistanceFunction, DistanceFunction<DBID>

Direct Known Subclasses:

DiskCacheBasedDoubleDistanceFunction, DiskCacheBasedFloatDistanceFunction, FileBasedSparseDoubleDistanceFunction, FileBasedSparseFloatDistanceFunction

public abstract class AbstractDBIDRangeDistanceFunction
extends AbstractDatabaseDistanceFunction<DBID>
implements DBIDRangeDistanceFunction

Abstract base class for distance functions that rely on integer offsets within a consecutive range. This is beneficial for external distances.

Since:

0.7.0

Author:

Erich Schubert

Nested Class Summary

Nested classes/interfaces inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDatabaseDistanceFunction

AbstractDatabaseDistanceFunction.Instance<O>

Constructor Summary

Constructors

Constructor and Description
AbstractDBIDRangeDistanceFunction()

Method Summary

Modifier and Type	Method and Description
double	distance(DBIDRef o1, DBIDRef o2) Returns the distance between the two objects specified by their object ids.
SimpleTypeInformation<DBID>	getInputTypeRestriction() Get the input data type of the function.
<O extends DBID> DistanceQuery<O>	instantiate(Relation<O> database) Instantiate with a database to get the actual distance query.

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

isMetric, isSymmetric

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.distance.distancefunction.DBIDRangeDistanceFunction

checkRange, distance

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

isMetric, isSquared, isSymmetric

Constructor Detail

AbstractDBIDRangeDistanceFunction

public AbstractDBIDRangeDistanceFunction()

Method Detail

distance

public double distance(DBIDRef o1,
                       DBIDRef o2)

Description copied from interface: DBIDDistanceFunction

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

Specified by:

distance in interface DBIDDistanceFunction

Parameters:

o1 - first object id

o2 - second object id

Returns:

the distance between the two objects specified by their object ids

getInputTypeRestriction

public SimpleTypeInformation<DBID> getInputTypeRestriction()

Description copied from interface: DistanceFunction

Get the input data type of the function.

Specified by:

getInputTypeRestriction in interface DistanceFunction<DBID>

Returns:

Type restriction

instantiate

public <O extends DBID> DistanceQuery<O> instantiate(Relation<O> database)

Description copied from interface: DistanceFunction

Instantiate with a database to get the actual distance query.

Specified by:

instantiate in interface DistanceFunction<DBID>

Parameters:

database - The representation to use

Returns:

Actual distance query.