Package etomica.lattice

Class IndexIteratorTriangular

java.lang.Object

etomica.lattice.IndexIteratorTriangular

All Implemented Interfaces:

IndexIterator, java.io.Serializable

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

Iterates arrays of int such that a[0] >= a[1] >= ... >= a[D-1] >= 0, where D is the length of the array, which is set at construction. Termination is specified via the maxElement field. For example, if D is 3, and maxElement is 2, iterator will return with successive calls to next():
{0,0,0}
{1,0,0}
{1,1,0}
{1,1,1}
{2,0,0}
{2,1,0}
{2,1,1}
{2,2,0}
{2,2,1}
{2,2,2}
The iterator may be set to disallow equal elements, so that iterates instead obey a[0] > a[1] > ... > a[D-1] >= 0. Then, for example, if D = 3 and maxElement is 4, successive calls to next() return
{2,1,0}
{3,1,0}
{3,2,0}
{3,2,1}
{4,1,0}
{4,2,0}
{4,2,1}
{4,3,0}
{4,3,1}
{4,3,2}

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
IndexIteratorTriangular(int D)	Constructs iterator that will return int arrays of length D.

Method Summary

Modifier and Type	Method	Description
int	getD()	Returns the length of the int array that is returned as each iterate.
int	getMaxElement()
int	getMaxElementMin()
boolean	hasNext()	Indicates whether prespecified number of iterate have been returned since last call to reset().
boolean	isAllowEqualElements()
static void	main(java.lang.String[] args)	Method to test and demonstrate class.
int[]	next()	Returns the next iterate.
void	reset()	Sets iterator to begin returning iterates.
void	setAllowEqualElements(boolean b)	Sets flag indicating whether iterates may have elements that are equal to one another.
void	setMaxElement(int maxElement)	Sets the largest allow value for any element to have.
void	setMaxElementMin(int maxElementMin)

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexIteratorTriangular

public IndexIteratorTriangular(int D)

Constructs iterator that will return int arrays of length D. Default value of maxElement is D-1.

Method Detail

hasNext

public boolean hasNext()

Indicates whether prespecified number of iterate have been returned since last call to reset().

Specified by:

hasNext in interface IndexIterator

next

public int[] next()

Returns the next iterate. Status of hasNext is not relevant to behavior, and will continue return new iterates with repeated calls. 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.

Specified by:

next in interface IndexIterator

reset

public void reset()

Sets iterator to begin returning iterates.

Specified by:

reset in interface IndexIterator

getD

public int getD()

Returns the length of the int array that is returned as each iterate.

Specified by:

getD in interface IndexIterator

setAllowEqualElements

public void setAllowEqualElements(boolean b)

Sets flag indicating whether iterates may have elements that are equal to one another.

isAllowEqualElements

public boolean isAllowEqualElements()

getMaxElement

public int getMaxElement()

setMaxElement

public void setMaxElement(int maxElement)

Sets the largest allow value for any element to have. If allowEqualElements, the last iterate from the iterator will have all elements equal to this value; if not allowEqualElements, the last iterate will have its zeroth element equal to this value.

getMaxElementMin

public int getMaxElementMin()

setMaxElementMin

public void setMaxElementMin(int maxElementMin)

main

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

Method to test and demonstrate class.