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

Class DoubleIntegerDBIDPairList.Itr

java.lang.Object

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

All Implemented Interfaces:

DBIDArrayIter, DBIDArrayMIter, DBIDIter, DBIDMIter, DBIDRef, DoubleDBIDListIter, DoubleDBIDListMIter, IntegerDBIDArrayIter, IntegerDBIDIter, IntegerDBIDRef, ArrayIter, Iter, MIter

Enclosing class:

DoubleIntegerDBIDPairList

private class DoubleIntegerDBIDPairList.Itr
extends Object
implements DoubleDBIDListMIter, IntegerDBIDArrayIter

List iterator.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	pos

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DoubleIntegerDBIDPairList.Itr()

Method Summary

Methods

Modifier and Type	Method and Description
DoubleIntegerDBIDPairList.Itr	advance() Moves the iterator forward to the next entry.
DoubleIntegerDBIDPairList.Itr	advance(int count) Moves the iterator forward or backward by the given offset.
double	doubleValue() Get the double value
int	getOffset() Get current iterator offset.
DoubleDBIDPair	getPair() Materialize an object pair.
int	internalGetIndex() Get the internal index.
void	remove() Remove the object the iterator currently points to.
DoubleIntegerDBIDPairList.Itr	retract() Moves the iterator backward to the previous entry.
DoubleIntegerDBIDPairList.Itr	seek(int off) Moves the iterator to the given position
void	setDBID(DBIDRef ref) Update the current DBID value.
void	setDouble(double value) Update the value at the current 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

pos

int pos

Constructor Detail

DoubleIntegerDBIDPairList.Itr

private DoubleIntegerDBIDPairList.Itr()

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 DoubleIntegerDBIDPairList.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 DoubleDBIDListIter

Specified by:

advance in interface ArrayIter

Specified by:

advance in interface Iter

Returns:

The iterator itself.

getOffset

public int getOffset()

Description copied from interface: ArrayIter

Get current iterator offset.

Specified by:

getOffset in interface ArrayIter

Returns:

Iterator position

advance

public DoubleIntegerDBIDPairList.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 DoubleDBIDListIter

Specified by:

advance in interface ArrayIter

Parameters:

count - offset to move forward or backwards

Returns:

Iterator

retract

public DoubleIntegerDBIDPairList.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 DoubleDBIDListIter

Specified by:

retract in interface ArrayIter

Returns:

Iterator

seek

public DoubleIntegerDBIDPairList.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 DoubleDBIDListIter

Specified by:

seek in interface ArrayIter

Parameters:

off - Seek offset

Returns:

Iterator

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

doubleValue

public double doubleValue()

Description copied from interface: DoubleDBIDListIter

Get the double value

Specified by:

doubleValue in interface DoubleDBIDListIter

Returns:

double value

setDBID

public void setDBID(DBIDRef ref)

Description copied from interface: DoubleDBIDListMIter

Update the current DBID value.

Specified by:

setDBID in interface DoubleDBIDListMIter

Parameters:

ref - Current value.

setDouble

public void setDouble(double value)

Description copied from interface: DoubleDBIDListMIter

Update the value at the current position.

Specified by:

setDouble in interface DoubleDBIDListMIter

Parameters:

value - New value

getPair

public DoubleDBIDPair getPair()

Description copied from interface: DoubleDBIDListIter

Materialize an object pair. Note: currently, this will create a new object. In order to avoid the garbage collection overhead, it is preferable to use #doubleValue() and exploit that the iterator itself is a DBIDRef reference.

Specified by:

getPair in interface DoubleDBIDListIter

Returns:

object pair

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