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

Class UnmodifiableArrayDBIDs.UnmodifiableDBIDArrayIter

java.lang.Object

de.lmu.ifi.dbs.elki.database.ids.generic.UnmodifiableArrayDBIDs.UnmodifiableDBIDArrayIter

All Implemented Interfaces:

DBIDArrayIter, DBIDIter, DBIDRef, ArrayIter, Iter

Enclosing class:

UnmodifiableArrayDBIDs

class UnmodifiableArrayDBIDs.UnmodifiableDBIDArrayIter
extends Object
implements DBIDArrayIter

Make an existing DBIDMIter unmodifiable.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
private DBIDArrayIter	it Wrapped iterator.

Constructor Summary

Constructors

Constructor and Description
UnmodifiableDBIDArrayIter(DBIDArrayIter it) Constructor.

Method Summary

Modifier and Type	Method and Description
DBIDArrayIter	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() Get the internal index.
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 de.lmu.ifi.dbs.elki.database.ids.DBIDRef

equals, hashCode

Field Detail

it

private DBIDArrayIter it

Wrapped iterator.

Constructor Detail

UnmodifiableDBIDArrayIter

public UnmodifiableDBIDArrayIter(DBIDArrayIter it)

Constructor.

Parameters:

it - inner iterator

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

internalGetIndex

public int internalGetIndex()

Description copied from interface: DBIDRef

Get the internal index. NOT FOR PUBLIC USE - ELKI Optimization engine only

Specified by:

internalGetIndex in interface DBIDRef

Returns:

Internal index

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 DBIDArrayIter

Specified by:

advance in interface ArrayIter

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 DBIDArrayIter

Specified by:

retract in interface ArrayIter

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