Package elki.database.ids.integer

Class IntegerDBIDPair.Itr

java.lang.Object

elki.database.ids.integer.IntegerDBIDPair.Itr

All Implemented Interfaces:

DBIDArrayIter, DBIDIter, DBIDRef, IntegerDBIDArrayIter, IntegerDBIDIter, IntegerDBIDRef, ArrayIter, Iter

Enclosing class:

IntegerDBIDPair

private static class IntegerDBIDPair.Itr
extends java.lang.Object
implements IntegerDBIDArrayIter

Iterator.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	first	State
(package private) int	pos	State
(package private) int	second	State

Constructor Summary

Constructors

Constructor	Description
Itr(int first, int second)	Constructor.

Method Summary

Modifier and Type	Method	Description
IntegerDBIDPair.Itr	advance()	Moves the iterator forward to the next entry.
DBIDArrayIter	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.
DBIDArrayIter	retract()	Moves the iterator backward to the previous entry.
DBIDArrayIter	seek(int off)	Moves the iterator to the given position
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, toString, wait, wait, wait

Methods inherited from interface elki.database.ids.DBIDIter

addTo

Methods inherited from interface elki.database.ids.DBIDRef

equals, hashCode

Field Detail

first

int first

State

second

int second

State

pos

int pos

State

Constructor Detail

Itr

public Itr(int first,
           int second)

Constructor.

Parameters:

first - First ID

second - Second ID

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

advance

public IntegerDBIDPair.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.

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

getOffset

public int getOffset()

Description copied from interface: ArrayIter

Get current iterator offset.

Specified by:

getOffset in interface ArrayIter

Returns:

Iterator position

advance

public DBIDArrayIter 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 DBIDArrayIter 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 DBIDArrayIter 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

Parameters:

off - Seek offset

Returns:

Iterator