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:

DBIDArrayIter, DBIDArrayMIter, DBIDIter, DBIDMIter, DBIDRef, IntegerDBIDArrayIter, IntegerDBIDArrayMIter, IntegerDBIDIter, IntegerDBIDMIter, IntegerDBIDRef, ArrayIter, Iter, MIter

Enclosing class:

TroveArrayDBIDs

protected static class TroveArrayDBIDs.DBIDItr
extends Object
implements IntegerDBIDArrayMIter

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.
void	advance(int count) Moves the iterator forward or backward by the given offset.
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.
int	getOffset() Get current iterator offset.
int	hashCode() WARNING: Hash codes of this interface might not be stable (e.g. for iterators).
int	internalGetIndex() Return the integer value of the object ID.
void	remove() Remove the object the iterator currently points to.
void	retract() Moves the iterator backward to the previous entry.
void	seek(int off) Moves the iterator to the given position
String	toString()
boolean	valid() Returns true if the iterator currently points to a valid object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

advance

public void advance(int count)

Description copied from interface: ArrayIter

Moves the iterator forward or backward by the given offset.

Specified by:

advance in interface ArrayIter

Parameters:

count - offset to move forward or backwards

retract

public void retract()

Description copied from interface: ArrayIter

Moves the iterator backward to the previous entry.

Specified by:

retract in interface ArrayIter

seek

public void seek(int off)

Description copied from interface: ArrayIter

Moves the iterator to the given position

Specified by:

seek in interface ArrayIter

Parameters:

off - Seek offset

getOffset

public int getOffset()

Description copied from interface: ArrayIter

Get current iterator offset.

Specified by:

getOffset in interface ArrayIter

Returns:

Iterator position

internalGetIndex

public int internalGetIndex()

Description copied from interface: IntegerDBIDRef

Return the integer value of the object ID.

Specified by:

internalGetIndex in interface DBIDRef

Specified by:

internalGetIndex in interface IntegerDBIDRef

Returns:

integer id

remove

public void remove()

Description copied from interface: DBIDMIter

Remove the object the iterator currently points to. Note: Subsequent calls to DBIDUtil.deref(de.lmu.ifi.dbs.elki.database.ids.DBIDRef) 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

Specified by:

remove in interface MIter

hashCode

public int hashCode()

Description copied from interface: DBIDRef

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!

Specified by:

hashCode in interface DBIDRef

Overrides:

hashCode in class Object

Returns:

current hash code (may change!)

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

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

toString

public String toString()

Overrides:

toString in class Object