Package etomica.lattice

Class RectangularLattice.Iterator

java.lang.Object

etomica.lattice.RectangularLattice.Iterator

All Implemented Interfaces:

SiteIterator, java.io.Serializable

Enclosing class:

RectangularLattice

public static class RectangularLattice.Iterator
extends java.lang.Object
implements SiteIterator, java.io.Serializable

Iterates over all sites of the lattice.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Iterator(int D)

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()	Indicates whether the iterator has another site to return.
java.lang.Object	next()	Returns the next iterate.
int[]	nextIndex()	Returns the index of the next iterate while advancing iterator.
java.lang.Object	peek()	Returns the next iterate without advancing the iterator.
void	reset()	Puts the iterator in a state ready to begin iteration.
void	setLattice(FiniteLattice lattice)	Sets the lattice having the sites to be given by this iterator.
int	size()	Returns the number of iterates that this iterator would give if reset.
void	unset()	Puts the iterator in a state such that hasNext is false.

Methods inherited from class java.lang.Object

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

Constructor Detail

Iterator

public Iterator(int D)

Method Detail

hasNext

public boolean hasNext()

Description copied from interface: SiteIterator

Indicates whether the iterator has another site to return.

Specified by:

hasNext in interface SiteIterator

next

public java.lang.Object next()

Description copied from interface: SiteIterator

Returns the next iterate.

Specified by:

next in interface SiteIterator

nextIndex

public int[] nextIndex()

Description copied from interface: SiteIterator

Returns the index of the next iterate while advancing iterator. A call to peek() following by nextIndex() is the best way to obtain both the next site and its index, if both are desired at once. Take care to copy values in another array if planned for use after next iteration--values in returned array may be changed when iterator is advanced. No meaningful value is returned if hasNext is false.

Specified by:

nextIndex in interface SiteIterator

peek

public java.lang.Object peek()

Description copied from interface: SiteIterator

Returns the next iterate without advancing the iterator.

Specified by:

peek in interface SiteIterator

reset

public void reset()

Description copied from interface: SiteIterator

Puts the iterator in a state ready to begin iteration.

Specified by:

reset in interface SiteIterator

size

public int size()

Description copied from interface: SiteIterator

Returns the number of iterates that this iterator would give if reset.

Specified by:

size in interface SiteIterator

unset

public void unset()

Description copied from interface: SiteIterator

Puts the iterator in a state such that hasNext is false.

Specified by:

unset in interface SiteIterator

setLattice

public void setLattice(FiniteLattice lattice)

Description copied from interface: SiteIterator

Sets the lattice having the sites to be given by this iterator.

Specified by:

setLattice in interface SiteIterator