Package etomica.molecule.iterator

Class IteratorFactory

java.lang.Object

etomica.molecule.iterator.IteratorFactory

All Implemented Interfaces:

java.io.Serializable

public class IteratorFactory
extends java.lang.Object
implements java.io.Serializable

Class for construction of iterators of molecules. Iterators are given for looping over single molecules and pairs of molecules. Different pair iterators are provided for looping pairs from the same species, and pairs from different species. Straightforward iterators are given by IteratorFactorySimple, which generates pairs from the childlists of species agents. Iteration based on cell lists is performed by iterators given by IteratorFactoryCell, in the etomica.nbr.cell package.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static IteratorFactory	INSTANCE

Constructor Summary

Constructors

Constructor	Description
IteratorFactory()

Method Summary

Modifier and Type	Method	Description
MoleculesetIteratorPDT	makeInterspeciesPairIterator(ISpecies[] species)	creates a pair iterator which loops over all pairs in a neighbor list between two groups
MoleculesetIteratorPDT	makeIntraspeciesPairIterator(ISpecies species)	creates a pair iterator which loops over all pairs in a neighbor list within one group
MoleculesetIteratorPDT	makeMoleculeIterator(ISpecies[] species)	Selects an appropriate iterator for the given species array.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final IteratorFactory INSTANCE

Constructor Detail

IteratorFactory

public IteratorFactory()

Method Detail

makeMoleculeIterator

public MoleculesetIteratorPDT makeMoleculeIterator(ISpecies[] species)

Selects an appropriate iterator for the given species array. If array contains only one element, an atom iterator is returned. If array contains two elements, an atom-pair iterator is returned, as given by the makeIntraSpeciesPairIterator method if both elements of the array are equal, or as given by the makeInterSpeciesPairIterator method if the array elements are different.

Parameters:

species - array used to determine type of iterator to return

Returns:

an appropriate iterator for looping over molecules of the given species

makeInterspeciesPairIterator

public MoleculesetIteratorPDT makeInterspeciesPairIterator(ISpecies[] species)

creates a pair iterator which loops over all pairs in a neighbor list between two groups

Returns:

the pair iterator

makeIntraspeciesPairIterator

public MoleculesetIteratorPDT makeIntraspeciesPairIterator(ISpecies species)

creates a pair iterator which loops over all pairs in a neighbor list within one group

Returns:

the pair iterator