Package etomica.lattice

Interface SiteIterator

All Known Implementing Classes:

CellLattice.NeighborIterator, RectangularLattice.Iterator, RectangularLatticeNbrIterator, RectangularLatticeNbrIteratorAdjacent, RectangularLatticeNbrIteratorSquare

public interface SiteIterator

Interface for objects that iterate over some or all of the sites of a lattice.

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.

Method Detail

hasNext

boolean hasNext()

Indicates whether the iterator has another site to return.

nextIndex

int[] nextIndex()

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.

next

java.lang.Object next()

Returns the next iterate.

peek

java.lang.Object peek()

Returns the next iterate without advancing the iterator.

reset

void reset()

Puts the iterator in a state ready to begin iteration.

size

int size()

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

unset

void unset()

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

setLattice

void setLattice(FiniteLattice lattice)

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