Package etomica.atom.iterator

Interface AtomsetIteratorBasisDependent

All Superinterfaces:

AtomLeafsetIterator, AtomsetIterator, AtomsetIteratorTargetable

All Known Subinterfaces:

AtomIteratorBasisDependent

All Known Implementing Classes:

ANIntergroupCoupled, ANIntergroupExchange, ANIntragroupExchange, ApiIndexList, ApiIntergroup, ApiIntergroupCoupled, ApiIntergroupExchange, ApiIntergroupIntraSpecies, ApiIntragroup, AtomIteratorBasis, AtomIteratorBasisAdjustableStart, AtomIteratorBasisFilteredType, AtomIteratorBasisFilteredType2, Atomset3IteratorIndexList, Atomset4IteratorIndexList, AtomsetIteratorAllLeafAtoms, PotentialMaster.AtomIterator0

public interface AtomsetIteratorBasisDependent
extends AtomsetIteratorTargetable

Interface for an AtomIterator that can be conditioned with target and basis atoms.

Method Summary

Modifier and Type	Method	Description
int	basisSize()	Indicates the size of the basis needed to set the iterator.
boolean	haveTarget(IAtom target)	Returns true if the iterator with its current basis would return an iterate for the given target.
void	setBasis(IMoleculeList atoms)	Identifies the atoms that form the basis for iteration, such that the childList atoms of those given will form the iterates.

Methods inherited from interface etomica.atom.iterator.AtomLeafsetIterator

next

Methods inherited from interface etomica.atom.iterator.AtomsetIterator

nBody, reset, size, unset

Methods inherited from interface etomica.atom.iterator.AtomsetIteratorTargetable

setTarget

Method Detail

setBasis

void setBasis(IMoleculeList atoms)

Identifies the atoms that form the basis for iteration, such that the childList atoms of those given will form the iterates.

Parameters:

atoms - The basis atoms; a null basis will condition the iterator to give no iterates until a valid basis is specified via another call to this method.

basisSize

int basisSize()

Indicates the size of the basis needed to set the iterator. The length of the array given to setBasis should be this value.

Returns:

the size of the basis for this iterator.

haveTarget

boolean haveTarget(IAtom target)

Returns true if the iterator with its current basis would return an iterate for the given target.