Package etomica.lattice

Class RectangularLatticeNbrIterator

java.lang.Object

etomica.lattice.RectangularLatticeNbrIterator

All Implemented Interfaces:

SiteIterator, java.io.Serializable

Direct Known Subclasses:

RectangularLatticeNbrIteratorAdjacent, RectangularLatticeNbrIteratorSquare

public abstract class RectangularLatticeNbrIterator
extends java.lang.Object
implements SiteIterator, java.io.Serializable

An abstract iterator that generates the neighboring sites of a given site. Subclasses provide the specification of the "neighbors" of a site by a suitable implementation of the updateNeighborList method.

Iterator can be configured to yield the up- and/or down-neighbors of the site. The definition of "up" and "down" neighbors is made by the subclass, within the restriction that if site B is an up-neighbor of site A, then A will be a down-neighbor of site B. Note that because of the way periodic boundaries are treated, a transitive relation is not guaranteed, meaning that (B upNbr of A) and (C upNbr of B) does not imply (C upNbr of A).

The central site is not included among the iterates (not a self-neighbor).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	cursor
protected int	D
protected boolean	doDown
protected boolean	doUp
protected boolean[]	isPeriodic
protected RectangularLattice	lattice
protected boolean	needNeighborUpdate
protected int	neighborCount
protected int[]	neighbors

Constructor Summary

Constructors

Constructor	Description
RectangularLatticeNbrIterator(int D)	Constructs iterator that needs to be configured before use.

Method Summary

Modifier and Type	Method	Description
int	D()
IteratorDirective.Direction	getDirection()	Gets the direction (up or down list) of the neighbors given by the iterator.
RectangularLattice	getLattice()	Returns the lattice from which the iterates are given.
boolean	hasNext()	Indicates whether the iterator has another site.
java.lang.Object	next()	Returns the next site in the iteration sequence, or null if hasNext is false.
int[]	nextIndex()	Returns the index of the next iterate while advancing the iterator.
java.lang.Object	peek()	Returns the next iterate without advancing the iterator.
void	reset()	Resets the iterator to loop through its iterates again.
void	setDirection(IteratorDirective.Direction direction)	Sets the iterator to return only up-list neighbors or down-list neighbors.
void	setLattice(FiniteLattice lattice)	Sets the lattice from which the iterates are given.
void	setPeriodicity(boolean[] periodicity)
void	setSite(int[] index)	Identifies the site whose neighbors will be given on iteration.
int	size()	The number of iterates returned by this iterator in its current state.
void	unset()	Puts iterator in a state in which hasNext() returns false.
protected abstract void	updateNeighborList()

Methods inherited from class java.lang.Object

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

Field Detail

D

protected final int D

needNeighborUpdate

protected boolean needNeighborUpdate

neighbors

protected int[] neighbors

lattice

protected RectangularLattice lattice

cursor

protected int cursor

neighborCount

protected int neighborCount

doUp

protected boolean doUp

doDown

protected boolean doDown

isPeriodic

protected final boolean[] isPeriodic

Constructor Detail

RectangularLatticeNbrIterator

public RectangularLatticeNbrIterator(int D)

Constructs iterator that needs to be configured before use. Must specify the central site and the range before reset and iteration.

Method Detail

updateNeighborList

protected abstract void updateNeighborList()

D

public final int D()

setSite

public void setSite(int[] index)

Identifies the site whose neighbors will be given on iteration. Requires subsequent call to reset before iteration.

Parameters:

index - the coordinate of the central site

hasNext

public final boolean hasNext()

Indicates whether the iterator has another site.

Specified by:

hasNext in interface SiteIterator

reset

public void reset()

Resets the iterator to loop through its iterates again. This must be done after any call to setRange, setDirection, or setSite.

Specified by:

reset in interface SiteIterator

unset

public void unset()

Puts iterator in a state in which hasNext() returns false.

Specified by:

unset in interface SiteIterator

nextIndex

public int[] nextIndex()

Returns the index of the next iterate while advancing the iterator.

Specified by:

nextIndex in interface SiteIterator

next

public java.lang.Object next()

Returns the next site in the iteration sequence, or null if hasNext is false.

Specified by:

next in interface SiteIterator

peek

public java.lang.Object peek()

Returns the next iterate without advancing the iterator.

Specified by:

peek in interface SiteIterator

size

public int size()

The number of iterates returned by this iterator in its current state.

Specified by:

size in interface SiteIterator

getDirection

public IteratorDirective.Direction getDirection()

Gets the direction (up or down list) of the neighbors given by the iterator. A null value indicates that all neighbors will be returned.

setDirection

public void setDirection(IteratorDirective.Direction direction)

Sets the iterator to return only up-list neighbors or down-list neighbors. A null value indicates that all neighbors are to be returned.

getLattice

public RectangularLattice getLattice()

Returns the lattice from which the iterates are given.

setLattice

public void setLattice(FiniteLattice lattice)

Sets the lattice from which the iterates are given. Dimension of lattice must be the same as that specified to constructor. Also, size of lattice must be compatible with range of neighbor interactions.

Specified by:

setLattice in interface SiteIterator

setPeriodicity

public void setPeriodicity(boolean[] periodicity)