magpie.utility

Class NDGridIterator

java.lang.Object

magpie.utility.NDGridIterator

All Implemented Interfaces:

java.util.Iterator<int[]>

public class NDGridIterator
extends java.lang.Object
implements java.util.Iterator<int[]>

Iterate over a n-dimensional array. Example: Iterate over all points in a x by y by z grid, increments from [0,0,0] to [x,y,z].

Constructor Summary

Constructors

Constructor and Description
NDGridIterator(int[] size) Initialize iterator
NDGridIterator(int dim, int size) Create a iterator over a

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
protected boolean	incrementCounter() Increment position of counter.
int[]	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

NDGridIterator

public NDGridIterator(int dim,
                      int size)

Create a iterator over a

Parameters:

dim - Dimension of grid

size - Number of points in each dimension

NDGridIterator

public NDGridIterator(int[] size)

Initialize iterator

Parameters:

size - Size of each dimension of grid

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<int[]>

next

public int[] next()

Specified by:

next in interface java.util.Iterator<int[]>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<int[]>

incrementCounter

protected boolean incrementCounter()

Increment position of counter.

Returns:

Whether the end has been reached