Package elki.database.ids.integer

Class ArrayModifiableIntegerDBIDs.Itr

java.lang.Object

elki.database.ids.integer.ArrayModifiableIntegerDBIDs.Itr

All Implemented Interfaces:

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

Enclosing class:

ArrayModifiableIntegerDBIDs

private class ArrayModifiableIntegerDBIDs.Itr
extends java.lang.Object
implements IntegerDBIDArrayMIter

Iterator class.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	pos	Iterator position.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Itr()

Method Summary

Modifier and Type	Method	Description
ArrayModifiableIntegerDBIDs.Itr	advance()	Moves the iterator forward to the next entry.
ArrayModifiableIntegerDBIDs.Itr	advance(int count)	Moves the iterator forward or backward by the given offset.
int	getOffset()	Get current iterator offset.
int	internalGetIndex()	Return the integer value of the object ID.
void	remove()	Remove the object the iterator currently points to.
ArrayModifiableIntegerDBIDs.Itr	retract()	Moves the iterator backward to the previous entry.
ArrayModifiableIntegerDBIDs.Itr	seek(int off)	Moves the iterator to the given position
void	setDBID(DBIDRef val)	Set the current value.
java.lang.String	toString()
boolean	valid()	Returns true if the iterator currently points to a valid object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface elki.database.ids.DBIDIter

addTo

Methods inherited from interface elki.database.ids.DBIDRef

equals, hashCode

Field Detail

pos

int pos

Iterator position.

Constructor Detail

Itr

private Itr()

Method Detail

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

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, whether the position is valid.

advance

public ArrayModifiableIntegerDBIDs.Itr advance()

Description copied from interface: Iter

Moves the iterator forward to the next entry.

Specified by:

advance in interface ArrayIter

Specified by:

advance in interface DBIDArrayIter

Specified by:

advance in interface DBIDIter

Specified by:

advance in interface Iter

Returns:

The iterator itself.

getOffset

public int getOffset()

Description copied from interface: ArrayIter

Get current iterator offset.

Specified by:

getOffset in interface ArrayIter

Returns:

Iterator position

advance

public ArrayModifiableIntegerDBIDs.Itr advance(int count)

Description copied from interface: ArrayIter

Moves the iterator forward or backward by the given offset.

Specified by:

advance in interface ArrayIter

Specified by:

advance in interface DBIDArrayIter

Parameters:

count - offset to move forward or backwards

Returns:

Iterator

retract

public ArrayModifiableIntegerDBIDs.Itr retract()

Description copied from interface: ArrayIter

Moves the iterator backward to the previous entry.

Specified by:

retract in interface ArrayIter

Specified by:

retract in interface DBIDArrayIter

Returns:

Iterator

seek

public ArrayModifiableIntegerDBIDs.Itr seek(int off)

Description copied from interface: ArrayIter

Moves the iterator to the given position

Specified by:

seek in interface ArrayIter

Specified by:

seek in interface DBIDArrayIter

Specified by:

seek in interface DBIDArrayMIter

Parameters:

off - Seek offset

Returns:

Iterator

setDBID

public void setDBID(DBIDRef val)

Description copied from interface: DBIDArrayMIter

Set the current value. Note: if the iterator is just after the last position, this may be equivalent to an add, but some implementations may not support this operation!

Specified by:

setDBID in interface DBIDArrayMIter

Parameters:

val - new value

remove

public void remove()

Description copied from interface: DBIDMIter

Remove the object the iterator currently points to. Note: Subsequent calls to DBIDUtil.deref(elki.database.ids.DBIDRef) may return a different element. Call DBIDIter.advance() to advance the iterator to the next element for further processing.

Specified by:

remove in interface DBIDMIter

Specified by:

remove in interface MIter

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object