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

Class TroveArrayDBIDs.DBIDItr

java.lang.Object

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

All Implemented Interfaces:

DBIDIter, DBIDMIter, DBIDRef, Iter

Enclosing class:

TroveArrayDBIDs

protected static class TroveArrayDBIDs.DBIDItr
extends Object
implements DBIDMIter

Iterate over a Trove IntList, ELKI/C-style

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	pos Current position
(package private) gnu.trove.list.TIntList	store The actual store we use

Constructor Summary

Constructors

Constructor and Description
TroveArrayDBIDs.DBIDItr(gnu.trove.list.TIntList store) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	advance() Moves the iterator forward to the next entry.
int	compareDBID(DBIDRef o) Compare two objects by the value of the referenced DBID.
boolean	equals(Object other) 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.
DBID	getDBID() Get the referenced DBID.
int	getIntegerID() Return the integer value of the object ID, if possible.
void	remove() Remove the object the iterator currently points to.
boolean	sameDBID(DBIDRef other) Compare the current value of two referenced DBIDs.
boolean	valid() Returns true if the iterator currently points to a valid object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

hashCode

Field Detail

pos

int pos

Current position

store

gnu.trove.list.TIntList store

The actual store we use

Constructor Detail

TroveArrayDBIDs.DBIDItr

public TroveArrayDBIDs.DBIDItr(gnu.trove.list.TIntList store)

Constructor.

Parameters:

store - The actual trove store

Method Detail

valid

public boolean valid()

Description copied from interface: Iter

Returns true if the iterator currently points to a valid object.

Specified by:

valid in interface Iter

Returns:

a boolean value

advance

public void advance()

Description copied from interface: Iter

Moves the iterator forward to the next entry.

Specified by:

advance in interface Iter

getIntegerID

public int getIntegerID()

Description copied from interface: DBIDRef

Return the integer value of the object ID, if possible.

Specified by:

getIntegerID in interface DBIDRef

Returns:

integer id

getDBID

public DBID getDBID()

Description copied from interface: DBIDIter

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 DBIDIter

Specified by:

getDBID in interface DBIDRef

Returns:

referenced DBID

remove

public void remove()

Description copied from interface: DBIDMIter

Remove the object the iterator currently points to. Subsequent calls to DBIDIter.getDBID() may return a different element. Call Iter.advance() to advance the iterator to the next element for further processing.

Specified by:

remove in interface DBIDMIter

sameDBID

public boolean sameDBID(DBIDRef other)

Description copied from interface: DBIDRef

Compare the current value of two referenced DBIDs.

Specified by:

sameDBID in interface DBIDRef

Parameters:

other - Other DBID reference (or DBID)

Returns:

true when the references currently refer to the same.

equals

public boolean equals(Object other)

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.

Specified by:

equals in interface DBIDRef

Overrides:

equals in class Object

Parameters:

other - Object to compare with

Returns:

True when they are the same object

compareDBID

public int compareDBID(DBIDRef o)

Description copied from interface: DBIDRef

Compare two objects by the value of the referenced DBID.

Specified by:

compareDBID in interface DBIDRef

Parameters:

o - Other DBID or object

Returns:

-1, 0 or +1