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

Class IntegerDBIDRange.DBIDItr

java.lang.Object

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

All Implemented Interfaces:

DBIDArrayIter, DBIDIter, DBIDRef, IntegerDBIDRef, ArrayIter, Iter

Enclosing class:

IntegerDBIDRange

protected static class IntegerDBIDRange.DBIDItr
extends Object
implements DBIDArrayIter, IntegerDBIDRef

Iterator in ELKI/C++ style.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	len Interval length.
(package private) int	pos Current position.
(package private) int	start Interval start.

Constructor Summary

Constructors

Constructor and Description
IntegerDBIDRange.DBIDItr(int start, int len) Constructor.

Method Summary

Methods

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

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

hashCode

Field Detail

pos

int pos

Current position.

len

final int len

Interval length.

start

final int start

Interval start.

Constructor Detail

IntegerDBIDRange.DBIDItr

IntegerDBIDRange.DBIDItr(int start,
                        int len)

Constructor.

Parameters:

start - Interval start

len - Interval length

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

advance

public void advance()

Description copied from interface: Iter

Moves the iterator forward to the next entry.

Specified by:

advance in interface Iter

advance

public void advance(int count)

Description copied from interface: ArrayIter

Moves the iterator forward or backward by the given offset.

Specified by:

advance in interface ArrayIter

Parameters:

count - offset to move forward or backwards

retract

public void retract()

Description copied from interface: ArrayIter

Moves the iterator backward to the previous entry.

Specified by:

retract in interface ArrayIter

seek

public void seek(int off)

Description copied from interface: ArrayIter

Moves the iterator to the given position

Specified by:

seek in interface ArrayIter

Parameters:

off - Seek offset

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

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

equals

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

Parameters:

other - Object to compare with

Returns:

True when they are the same object

toString

public String toString()

Overrides:

toString in class Object