Class MultidimensionalCounter.Iterator

java.lang.Object

org.apache.commons.math3.util.MultidimensionalCounter.Iterator

All Implemented Interfaces:

Iterator<Integer>

Enclosing class:

MultidimensionalCounter

public class MultidimensionalCounter.Iterator
extends Object
implements Iterator<Integer>

Perform iteration over the multidimensional counter.

Since:

2.2

Method Summary

Modifier and Type	Method	Description
int	getCount()	Get the current unidimensional counter slot.
int	getCount(int dim)	Get the current count in the selected dimension.
int[]	getCounts()	Get the current multidimensional counter slots.
boolean	hasNext()
Integer	next()
void	remove()

Methods inherited from class Object

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

Methods inherited from interface Iterator

forEachRemaining

Method Details

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Integer>

next

public Integer next()

Specified by:

next in interface Iterator<Integer>

Returns:

the unidimensional count after the counter has been incremented by 1.

Throws:

NoSuchElementException - if hasNext() would have returned false.

getCount

public int getCount()

Get the current unidimensional counter slot.

Returns:

the index within the unidimensionl counter.

getCounts

public int[] getCounts()

Get the current multidimensional counter slots.

Returns:

the indices within the multidimensional counter.

getCount

public int getCount(int dim)

Get the current count in the selected dimension.

Parameters:

dim - Dimension index.

Returns:

the count at the corresponding index for the current state of the iterator.

Throws:

IndexOutOfBoundsException - if index is not in the correct interval (as defined by the length of the argument in the constructor of the enclosing class).

remove

public void remove()

Specified by:

remove in interface Iterator<Integer>

Throws:

UnsupportedOperationException