Package etomica.lattice

Class IndexIteratorRectangular

java.lang.Object

etomica.lattice.IndexIteratorRectangular

All Implemented Interfaces:

IndexIterator, IndexIteratorSizable, java.io.Serializable

public class IndexIteratorRectangular
extends java.lang.Object
implements IndexIterator, IndexIteratorSizable, java.io.Serializable

Iterates arrays of int, such that 0 <= a[0] <= size[0], 0 <= a[1] <= size[1], etc., thereby spanning a rectangular region. For example, if size = {3,2}, iteration would give these values and then expire:
{0,0}
{0,1}
{1,0}
{1,1}
{2,0}
{2,1}

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
IndexIteratorRectangular(int D)	Constructs iterator that returns int arrays of length D.

Method Summary

Modifier and Type	Method	Description
int	getD()	Returns the length of the integer array that is returned as an iterate.
boolean	hasNext()	Indicates whether all iterates have been returned since last call to reset().
static void	main(java.lang.String[] args)	main method to test and demonstrate class.
int[]	next()	Returns the next iterate, or null if hasNext is false.
void	reset()	Puts iterator in a condition to begin iteration.
void	setSize(int size)	Sets range of all indexes to the given value Indices returned vary from 0 to size-1
void	setSize(int[] size)	Sets the individual ranges for the elements of the returned array.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexIteratorRectangular

public IndexIteratorRectangular(int D)

Constructs iterator that returns int arrays of length D. Default size is 1 for each dimension, so that only the iterate {0,0,..,0} is returned; setSize can be used to modify the range. Call to reset is required before beginning iteration, in any case.

Method Detail

reset

public void reset()

Puts iterator in a condition to begin iteration. First iterate is {0,...,0}

Specified by:

reset in interface IndexIterator

hasNext

public boolean hasNext()

Indicates whether all iterates have been returned since last call to reset().

Specified by:

hasNext in interface IndexIterator

next

public int[] next()

Returns the next iterate, or null if hasNext is false. The same array instance is returned with each call to this method; only its element values are modified in accordance with the design of the iteration. Elements of returned array may be modified and will not affect iteration.

Specified by:

next in interface IndexIterator

setSize

public void setSize(int size)

Sets range of all indexes to the given value Indices returned vary from 0 to size-1

setSize

public void setSize(int[] size)

Sets the individual ranges for the elements of the returned array. Each element index[k] iterates over values from 0 to size[k]-1.

Specified by:

setSize in interface IndexIteratorSizable

getD

public int getD()

Returns the length of the integer array that is returned as an iterate.

Specified by:

getD in interface IndexIterator

main

public static void main(java.lang.String[] args)

main method to test and demonstrate class.