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

Class EmptyDBIDs.EmptyDBIDIterator

java.lang.Object

de.lmu.ifi.dbs.elki.database.ids.EmptyDBIDs.EmptyDBIDIterator

All Implemented Interfaces:

DBIDArrayIter, DBIDArrayMIter, DBIDIter, DBIDMIter, DBIDRef, ArrayIter, Iter, MIter

Enclosing class:

EmptyDBIDs

protected static class EmptyDBIDs.EmptyDBIDIterator
extends java.lang.Object
implements DBIDArrayMIter

Iterator for empty DBIDs-

Author:

Erich Schubert

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EmptyDBIDIterator()

Method Summary

Modifier and Type	Method and Description
EmptyDBIDs.EmptyDBIDIterator	advance() Moves the iterator forward to the next entry.
EmptyDBIDs.EmptyDBIDIterator	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	internalGetIndex() Internal only: Get the internal index.
void	remove() Remove the object the iterator currently points to.
EmptyDBIDs.EmptyDBIDIterator	retract() Moves the iterator backward to the previous entry.
EmptyDBIDs.EmptyDBIDIterator	seek(int off) Moves the iterator to the given position
void	setDBID(DBIDRef val) Set the current value.
boolean	valid() Returns true if the iterator currently points to a valid object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.database.ids.DBIDRef

hashCode

Constructor Detail

EmptyDBIDIterator

protected EmptyDBIDIterator()

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 EmptyDBIDs.EmptyDBIDIterator 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

Internal only: Get the internal index.

NOT FOR PUBLIC USE - ELKI Optimization engine only.

Specified by:

internalGetIndex in interface DBIDRef

Returns:

Internal index

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

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

advance

public EmptyDBIDs.EmptyDBIDIterator 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 EmptyDBIDs.EmptyDBIDIterator 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 EmptyDBIDs.EmptyDBIDIterator 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 DBIDArrayMIter

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

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