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

Interface DBIDRef

All Known Subinterfaces:

DBID, DBIDArrayIter, DBIDArrayMIter, DBIDIter, DBIDMIter, DBIDVar, DistanceDBIDPair<D>, DistanceDBIDResultIter<D>, DoubleDBIDPair, DoubleDistanceDBIDPair, DoubleDistanceDBIDResultIter, IntegerDBIDArrayIter, IntegerDBIDArrayMIter, IntegerDBIDIter, IntegerDBIDMIter, IntegerDBIDRef

All Known Implementing Classes:

DBIDIterAdapter, DistanceIntegerDBIDPair, DoubleDistanceDBIDList.Iter, DoubleDistanceIntegerDBIDPair, DoubleDistanceKNNList.Itr, EmptyDBIDs.EmptyDBIDIterator, GenericDistanceDBIDList.Iter, GenericKNNList.Itr, IntArrayStaticDBIDs.DBIDItr, IntegerDBID, IntegerDBID.DBIDItr, IntegerDBIDRange.DBIDItr, IntegerDBIDVar, IntegerDBIDVar.DBIDItr, IntegerDoubleDBIDPair, KNNUtil.KNNSubList.Itr, MaskedDBIDs.DBIDItr, MaskedDBIDs.InvDBIDItr, TroveArrayDBIDs.DBIDItr, TroveHashSetModifiableDBIDs.DBIDItr, UnmodifiableArrayDBIDs.UnmodifiableDBIDArrayIter, UnmodifiableDBIDs.UnmodifiableDBIDIter, UnmodifiableIntegerArrayDBIDs.UnmodifiableDBIDIter, UnmodifiableIntegerDBIDs.UnmodifiableDBIDIter

public interface DBIDRef

Some object referencing a DBID. Could be a DBID, a DBIDIter, for example. Important note: do not assume this reference to be stable. Iterators are a good example how the DBIDRef may change.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Deprecated.
int	hashCode() Deprecated. Do not use this hash code. Some implementations will not offer stable hash codes!
int	internalGetIndex() Get the internal index.

Method Detail

internalGetIndex

int internalGetIndex()

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

Returns:

Internal index

hashCode

@Deprecated
int hashCode()

Deprecated. Do not use this hash code. Some implementations will not offer stable hash codes!

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!

Overrides:

hashCode in class Object

Returns:

current hash code (may change!)

equals

@Deprecated
boolean equals(Object obj)

Deprecated.

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)!

Overrides:

equals in class Object

Parameters:

obj - Object to compare with

Returns:

True when they are the same object