Package etomica.atom.iterator

Interface AtomIterator

All Superinterfaces:

AtomLeafsetIterator, AtomsetIterator

All Known Subinterfaces:

AtomIteratorAtomDependent, AtomIteratorBasisDependent, AtomIteratorBoxDependent

All Known Implementing Classes:

AtomIteratorArrayList, AtomIteratorArrayListAdjacent, AtomIteratorArrayListSimple, AtomIteratorBasis, AtomIteratorBasisAdjustableStart, AtomIteratorBasisFilteredType, AtomIteratorBasisFilteredType2, AtomIteratorLeafAtoms, AtomIteratorLeafFilteredType, AtomIteratorNull, AtomIteratorSinglet, MCMoveInsertDeleteLatticeVacancy.AtomIteratorBruteForce, MCMoveInsertDeleteLatticeVacancy.AtomIteratorNbr, MCMoveInsertDeleteLatticeVacancy.AtomIteratorNbrCell

public interface AtomIterator
extends AtomLeafsetIterator

Interface for classes that loop over a set of atoms. Permits iteration via a hasNext()-next() while loop (iterator returns atoms to client) or via a call to allAtoms(AtomActive) (client gives action to iterator).

Method Summary

Modifier and Type	Method	Description
IAtom	nextAtom()	Returns the next atom in the iteration sequence, or null if hasNext() is false.

Methods inherited from interface etomica.atom.iterator.AtomLeafsetIterator

next

Methods inherited from interface etomica.atom.iterator.AtomsetIterator

nBody, reset, size, unset

Method Detail

nextAtom

IAtom nextAtom()

Returns the next atom in the iteration sequence, or null if hasNext() is false.