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

Interface DBIDIter

All Superinterfaces:

DBIDRef, Iter

All Known Subinterfaces:

DBIDMIter

All Known Implementing Classes:

DBIDIterAdapter, EmptyDBIDs.EmptyDBIDIterator, IntegerArrayStaticDBIDs.DBIDItr, IntegerDBID.DBIDItr, IntegerDBIDRange.DBIDItr, KNNUtil.DBIDItr, MaskedDBIDs.DBIDItr, MaskedDBIDs.InvDBIDItr, TroveArrayDBIDs.DBIDItr, TroveHashSetModifiableDBIDs.DBIDItr

public interface DBIDIter
extends DBIDRef, Iter

Iterator for DBIDs. Important note: this iterator has a significantly different syntax and semantics than the Java iterators. It is much more aligned with C than with Java, but at the same time, the syntax is much more compatible with for loops. Usage example:

 for (DBIDIter iter = ids.iter(); iter.valid(); iter.advance()) {
   iter.getDBID();
 }
 
 

We list some fundamental differences.

• iter.valid() refers to the current element, Iterator.next() to the next.
• iter.advance() does not return an element. Use get... to access it.
• DBIDIter.get... do not advance the iterator.

Method Summary

Methods

Modifier and Type	Method and Description
DBID	getDBID() Get the referenced DBID.

Methods inherited from interface de.lmu.ifi.dbs.elki.database.ids.DBIDRef

compareDBID, equals, getIntegerID, hashCode, sameDBID

Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.iterator.Iter

advance, valid

Method Detail

getDBID

DBID getDBID()

Get the referenced DBID. Efficiency note: this may require materialization of a DBID object - if possible, use DBIDRef based APIs instead.

Specified by:

getDBID in interface DBIDRef

Returns:

referenced DBID