Interface MatrixIterator

All Superinterfaces:

Comparable<MatrixIterator>, Iterator<MatrixTuple>

public interface MatrixIterator
extends Iterator<MatrixTuple>, Comparable<MatrixIterator>

A Comparable Iterator over MatrixTuples.

The comparison is based on the indices, not on the values. To use the comparator .next must have been called once.

Method Summary

Modifier and Type	Method	Description
default int	compareTo(MatrixIterator o)
MatrixTuple	getReference()	Gets the MatrixTuple reference that this iterator updates.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Details

getReference

MatrixTuple getReference()

Gets the MatrixTuple reference that this iterator updates.

Returns:

The matrix tuple.

compareTo

default int compareTo(MatrixIterator o)

Specified by:

compareTo in interface Comparable<MatrixIterator>