Package etomica.lattice

Interface FiniteLattice<T>

All Superinterfaces:

AbstractLattice<T>

All Known Implementing Classes:

CellLattice, RectangularLattice

public interface FiniteLattice<T>
extends AbstractLattice<T>

Interface for a lattice that has a finite, adjustable size. Size is quantified by the maximum value of the index in each dimension. Provides a method that permits all sites of the lattice to be returned in a 1-D array of objects.

Method Summary

Modifier and Type	Method	Description
int[]	getSize()	Returns an array with elements giving the maximum number of index values in each dimension.
void	setSize(int[] size)	Sets the array size, defined as described in the getSize method.
T[]	sites()	Returns an array containing all the sites in the lattice.

Methods inherited from interface etomica.lattice.AbstractLattice

D, site

Method Detail

sites

T[] sites()

Returns an array containing all the sites in the lattice.

getSize

int[] getSize()

Returns an array with elements giving the maximum number of index values in each dimension. If size[i] = k, then permissible values of index[i] are in the range (0, k-1) inclusive, where index is the index array given to the site method of AbstractLattice.

setSize

void setSize(int[] size)

Sets the array size, defined as described in the getSize method.