Package elki.database.ids

Interface DBIDRef

All Known Subinterfaces:

DBID, DBIDArrayIter, DBIDArrayMIter, DBIDIter, DBIDMIter, DBIDVar, DoubleDBIDHeap, DoubleDBIDIter, DoubleDBIDListIter, DoubleDBIDListMIter, DoubleDBIDPair, DoubleIntegerDBIDListIter, DoubleIntegerDBIDListMIter, IntegerDBIDArrayIter, IntegerDBIDArrayMIter, IntegerDBIDIter, IntegerDBIDMIter, IntegerDBIDRef, KNNHeap, PrioritySearcher<O>

All Known Implementing Classes:

ArrayModifiableIntegerDBIDs.Itr, ArrayModifiableIntegerDBIDs.Slice.SliceItr, ArrayStaticIntegerDBIDs.Itr, ArrayStaticIntegerDBIDs.Slice.SliceItr, CoverTree.CoverTreePriorityDBIDSearcher, CoverTree.CoverTreePriorityObjectSearcher, CoverTree.CoverTreePrioritySearcher, DoubleIntegerDBIDArrayList.Itr, DoubleIntegerDBIDHeap, DoubleIntegerDBIDHeap.UnorderedIter, DoubleIntegerDBIDKNNHeap, DoubleIntegerDBIDKNNHeap.UnorderedIter, DoubleIntegerDBIDPair, DoubleIntegerDBIDSubList.Itr, EmptyDBIDs.EmptyDBIDIterator, EuclideanRStarTreeDistancePrioritySearcher, ExactPrioritySearcher, FastutilIntOpenHashSetModifiableDBIDs.Itr, GNAT.GNATPriorityDBIDSearcher, GNAT.GNATPriorityObjectSearcher, GNAT.GNATPrioritySearcher, IntegerDBID, IntegerDBID.Itr, IntegerDBIDKNNSubList.Itr, IntegerDBIDPair.Itr, IntegerDBIDPair.Slice.SliceItr, IntegerDBIDRange.Itr, IntegerDBIDVar, IntegerDBIDVar.Itr, LinearScanEuclideanPrioritySearcher, LinearScanEuclideanPrioritySearcher.ByDBID, LinearScanEuclideanPrioritySearcher.ByObject, LinearScanPrioritySearcher, LinearScanPrioritySearcher.ByDBID, LinearScanPrioritySearcher.ByObject, MemoryKDTree.KDTreePrioritySearcher, MinimalisticMemoryKDTree.KDTreePrioritySearcher, PrecomputedDistanceMatrix.PrecomputedDistancePrioritySearcher, RStarTreeDistancePrioritySearcher, SimplifiedCoverTree.CoverTreePriorityDBIDSearcher, SimplifiedCoverTree.CoverTreePriorityObjectSearcher, SimplifiedCoverTree.CoverTreePrioritySearcher, SmallMemoryKDTree.KDTreePrioritySearcher, UnmodifiableIntegerArrayDBIDs.Itr, UnmodifiableIntegerDBIDs.UnmodifiableDBIDIter, VectorApproximation, VPTree.VPTreePriorityDBIDSearcher, VPTree.VPTreePriorityObjectSearcher, VPTree.VPTreePrioritySearcher, WrappedPrioritySearchDBIDByLookup, WrappedPrioritySearchDBIDByLookup.Linear

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	Description
boolean	equals(java.lang.Object obj)	Deprecated. Use DBIDUtil.equal(elki.database.ids.DBIDRef, elki.database.ids.DBIDRef) instead.
int	hashCode()	Deprecated. Do not use this hash code.
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(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(elki.database.ids.DBIDRef, 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(elki.database.ids.DBIDRef, elki.database.ids.DBIDRef) or DBIDUtil.compare(elki.database.ids.DBIDRef, 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