ArrayIter (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

All Superinterfaces:

Iter

All Known Subinterfaces:

DBIDArrayIter, DBIDArrayMIter, DoubleDBIDListIter, DoubleDBIDListMIter, DoubleIntegerDBIDListIter, DoubleIntegerDBIDListMIter, Histogram.Iter, IntegerDBIDArrayIter, IntegerDBIDArrayMIter

All Known Implementing Classes:

AbstractStaticHistogram.Iter, AbstractVectorIter, ArrayListIter, ArrayModifiableIntegerDBIDs.Itr, ArrayModifiableIntegerDBIDs.Slice.SliceItr, ArrayStaticIntegerDBIDs.Itr, ArrayStaticIntegerDBIDs.Slice.SliceItr, DecreasingVectorIter, DoubleHistogram.Iter, DoubleIntegerDBIDArrayList.Itr, DoubleIntegerDBIDSubList.Itr, EmptyDBIDs.EmptyDBIDIterator, IncreasingVectorIter, IntegerDBID.Itr, IntegerDBIDKNNSubList.Itr, IntegerDBIDPair.Itr, IntegerDBIDPair.Slice.SliceItr, IntegerDBIDRange.Itr, IntegerDBIDVar.Itr, ObjHistogram.Iter, UnmodifiableIntegerArrayDBIDs.Itr
```
public interface ArrayIter
extends Iter
```
Array iterators can also go backwards and seek.

Since:

0.5.5

Author:

Erich Schubert

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ArrayIter`	`advance()`	Moves the iterator forward to the next entry.
`ArrayIter`	`advance(int count)`	Moves the iterator forward or backward by the given offset.
`int`	`getOffset()`	Get current iterator offset.
`ArrayIter`	`retract()`	Moves the iterator backward to the previous entry.
`ArrayIter`	`seek(int off)`	Moves the iterator to the given position

Methods inherited from interface elki.utilities.datastructures.iterator.Iter
valid

- Method Detail
  - advance
```
ArrayIter advance()
```
    Description copied from interface: Iter
    
    Moves the iterator forward to the next entry.
    
    Specified by:
    
    advance in interface Iter
    
    Returns:
    
    The iterator itself.
  - advance
```
ArrayIter advance(int count)
```
    Moves the iterator forward or backward by the given offset.
    
    Parameters:
    
    count - offset to move forward or backwards
    
    Returns:
    
    Iterator
  - retract
```
ArrayIter retract()
```
    Moves the iterator backward to the previous entry.
    
    Returns:
    
    Iterator
  - seek
```
ArrayIter seek(int off)
```
    Moves the iterator to the given position
    
    Parameters:
    
    off - Seek offset
    
    Returns:
    
    Iterator
  - getOffset
```
int getOffset()
```
    Get current iterator offset.
    
    Returns:
    
    Iterator position