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

Class IntegerDBID.Itr

java.lang.Object

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

All Implemented Interfaces:

DBIDArrayIter, DBIDIter, DBIDRef, IntegerDBIDRef, ArrayIter, Iter

Enclosing class:

IntegerDBID

protected class IntegerDBID.Itr
extends java.lang.Object
implements DBIDArrayIter, IntegerDBIDRef

Pseudo iterator for DBIDs interface.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	pos Iterator position: We use an integer so we can support retract().

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Itr()

Method Summary

Modifier and Type	Method and Description
IntegerDBID.Itr	advance() Moves the iterator forward to the next entry.
IntegerDBID.Itr	advance(int count) Moves the iterator forward or backward by the given offset.
boolean	equals(java.lang.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() Internal only: Get the internal index.
IntegerDBID.Itr	retract() Moves the iterator backward to the previous entry.
IntegerDBID.Itr	seek(int off) Moves the iterator to the given position
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, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

pos

int pos

Iterator position: We use an integer so we can support retract().

Constructor Detail

Itr

protected Itr()

Method Detail

advance

public IntegerDBID.Itr advance()

Description copied from interface: Iter

Moves the iterator forward to the next entry.

Specified by:

advance in interface DBIDArrayIter

Specified by:

advance in interface DBIDIter

Specified by:

advance in interface ArrayIter

Specified by:

advance in interface Iter

Returns:

The iterator itself.

advance

public IntegerDBID.Itr advance(int count)

Description copied from interface: ArrayIter

Moves the iterator forward or backward by the given offset.

Specified by:

advance in interface DBIDArrayIter

Specified by:

advance in interface ArrayIter

Parameters:

count - offset to move forward or backwards

Returns:

Iterator

retract

public IntegerDBID.Itr retract()

Description copied from interface: ArrayIter

Moves the iterator backward to the previous entry.

Specified by:

retract in interface DBIDArrayIter

Specified by:

retract in interface ArrayIter

Returns:

Iterator

seek

public IntegerDBID.Itr seek(int off)

Description copied from interface: ArrayIter

Moves the iterator to the given position

Specified by:

seek in interface DBIDArrayIter

Specified by:

seek in interface ArrayIter

Parameters:

off - Seek offset

Returns:

Iterator

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: DBIDRef

Internal only: Get the internal index.

NOT FOR PUBLIC USE - ELKI Optimization engine only.

Specified by:

internalGetIndex in interface DBIDRef

Specified by:

internalGetIndex in interface IntegerDBIDRef

Returns:

Internal index

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.

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 java.lang.Object

Returns:

current hash code (may change!)

equals

public boolean equals(java.lang.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 java.lang.Object

Parameters:

other - Object to compare with

Returns:

True when they are the same object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object