etomica.atom.iterator

Interface MoleculesetIteratorBasisDependent

All Superinterfaces:

AtomsetIterator, MoleculesetIterator, MoleculesetIteratorTargetable

public interface MoleculesetIteratorBasisDependent
extends MoleculesetIteratorTargetable

Interface for an MoleculeIterator that can be conditioned with target and basis molecules.

Method Summary

Modifier and Type	Method and Description
int	basisSize() Indicates the size of the basis needed to set the iterator.
boolean	haveTarget(IMolecule target) Returns true if the iterator with its current basis would return an iterate for the given target.
void	setBasis(IMoleculeList molecules)

Methods inherited from interface etomica.atom.iterator.MoleculesetIteratorTargetable

setTarget

Methods inherited from interface etomica.atom.iterator.MoleculesetIterator

next

Methods inherited from interface etomica.atom.iterator.AtomsetIterator

nBody, reset, size, unset

Method Detail

setBasis

void setBasis(IMoleculeList molecules)

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(IMolecule target)

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