de.lmu.ifi.dbs.elki.database.ids.integer

Class DistanceIntegerDBIDPair<D extends Distance<D>>

java.lang.Object

de.lmu.ifi.dbs.elki.database.ids.integer.DistanceIntegerDBIDPair<D>

Type Parameters:

D - Distance type

All Implemented Interfaces:

DBIDRef, DistanceDBIDPair<D>, IntegerDBIDRef

 class DistanceIntegerDBIDPair<D extends Distance<D>>
extends Object
implements DistanceDBIDPair<D>, IntegerDBIDRef

Class storing a double distance a DBID.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) D	distance The distance value.
(package private) int	id The integer DBID.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DistanceIntegerDBIDPair(D distance, int id) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareByDistance(DistanceDBIDPair<D> o) Compare to another result, by distance, smaller first.
boolean	equals(Object o) WARNING: calling equality on a reference may be an indicator of incorrect usage, as it is not clear whether the programmer meant the references to be the same or the DBIDs.
D	getDistance() Get the distance.
int	hashCode() WARNING: Hash codes of this interface might not be stable (e.g. for iterators).
int	internalGetIndex() Get the internal index.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

distance

D extends Distance<D> distance

The distance value.

id

int id

The integer DBID.

Constructor Detail

DistanceIntegerDBIDPair

protected DistanceIntegerDBIDPair(D distance,
                       int id)

Constructor.

Parameters:

distance - Distance

id - Object ID

Method Detail

getDistance

public D getDistance()

Description copied from interface: DistanceDBIDPair

Get the distance.

Specified by:

getDistance in interface DistanceDBIDPair<D extends Distance<D>>

Returns:

Distance

internalGetIndex

public int internalGetIndex()

Description copied from interface: DBIDRef

Get the internal index. NOT FOR PUBLIC USE - ELKI Optimization engine only

Specified by:

internalGetIndex in interface DBIDRef

Specified by:

internalGetIndex in interface IntegerDBIDRef

Returns:

Internal index

compareByDistance

public int compareByDistance(DistanceDBIDPair<D> o)

Description copied from interface: DistanceDBIDPair

Compare to another result, by distance, smaller first.

Specified by:

compareByDistance in interface DistanceDBIDPair<D extends Distance<D>>

Parameters:

o - Other result

Returns:

Comparison result

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from interface: DBIDRef

WARNING: calling equality on a reference may be an indicator of incorrect usage, as it is not clear whether the programmer meant the references to be the same or the DBIDs. Use DBIDUtil.equal(de.lmu.ifi.dbs.elki.database.ids.DBIDRef, de.lmu.ifi.dbs.elki.database.ids.DBIDRef) or DBIDUtil.compare(de.lmu.ifi.dbs.elki.database.ids.DBIDRef, de.lmu.ifi.dbs.elki.database.ids.DBIDRef)!

Specified by:

equals in interface DBIDRef

Overrides:

equals in class Object

Parameters:

o - Object to compare with

Returns:

True when they are the same object

hashCode

public int hashCode()

Description copied from interface: DBIDRef

WARNING: Hash codes of this interface might not be stable (e.g. for iterators). Use DBIDUtil.deref(de.lmu.ifi.dbs.elki.database.ids.DBIDRef) to get an object with a stable hash code!

Specified by:

hashCode in interface DBIDRef

Overrides:

hashCode in class Object

Returns:

current hash code (may change!)