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

Interface DBIDRef

All Known Subinterfaces:

DBID, DBIDArrayIter, DBIDArrayMIter, DBIDIter, DBIDMIter, DBIDVar, DoubleDBIDListIter, DoubleDBIDListMIter, DoubleDBIDPair, DoubleIntegerDBIDListIter, DoubleIntegerDBIDListMIter, IntegerDBIDArrayIter, IntegerDBIDArrayMIter, IntegerDBIDIter, IntegerDBIDMIter, IntegerDBIDRef

All Known Implementing Classes:

ArrayModifiableIntegerDBIDs.Itr, ArrayModifiableIntegerDBIDs.Slice.SliceItr, ArrayStaticIntegerDBIDs.Itr, ArrayStaticIntegerDBIDs.Slice.SliceItr, DoubleIntegerDBIDArrayList.Itr, DoubleIntegerDBIDKNNHeap.UnorderedIter, DoubleIntegerDBIDPair, DoubleIntegerDBIDSubList.Itr, EmptyDBIDs.EmptyDBIDIterator, FastutilIntOpenHashSetModifiableDBIDs.Itr, IntegerDBID, IntegerDBID.Itr, IntegerDBIDKNNSubList.Itr, IntegerDBIDPair.Itr, IntegerDBIDPair.Slice.SliceItr, IntegerDBIDRange.Itr, IntegerDBIDVar, IntegerDBIDVar.Itr, UnmodifiableIntegerArrayDBIDs.Itr, 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.

Since:

0.5.0

Author:

Erich Schubert

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Deprecated. Use DBIDUtil.equal(de.lmu.ifi.dbs.elki.database.ids.DBIDRef, de.lmu.ifi.dbs.elki.database.ids.DBIDRef) instead.
int	hashCode() Deprecated. Do not use this hash code. Some implementations will not offer stable hash codes!
int	internalGetIndex() Internal only: Get the internal index.

Method Detail

internalGetIndex

int internalGetIndex()

Internal only: 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 java.lang.Object

Returns:

current hash code (may change!)

equals

@Deprecated
boolean equals(java.lang.Object obj)

Deprecated. Use DBIDUtil.equal(de.lmu.ifi.dbs.elki.database.ids.DBIDRef, de.lmu.ifi.dbs.elki.database.ids.DBIDRef) instead.

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 java.lang.Object

Parameters:

obj - Object to compare with

Returns:

True when they are the same object