Package etomica.atom.iterator

Class ApiLeafAtoms

java.lang.Object

etomica.atom.iterator.ApiIntraArrayList

etomica.atom.iterator.ApiLeafAtoms

All Implemented Interfaces:

AtomLeafsetIterator, AtomsetIterator, AtomsetIteratorBoxDependent

Direct Known Subclasses:

ApiFilteredCylinder

public class ApiLeafAtoms
extends ApiIntraArrayList
implements AtomsetIteratorBoxDependent

Iterator that returns all pairs that can be formed from all leaf atoms of a given box.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ApiLeafAtoms()	Creates new pair iterator that requires reset() before beginning iteration.

Method Summary

Modifier and Type	Method	Description
void	setBox(Box box)	Conditions iterator to return all leaf-atom pairs from the given box.

Methods inherited from class etomica.atom.iterator.ApiIntraArrayList

getList, nBody, next, reset, setList, size, unset

Methods inherited from interface etomica.atom.iterator.AtomLeafsetIterator

next

Methods inherited from interface etomica.atom.iterator.AtomsetIterator

nBody, reset, size, unset

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiLeafAtoms

public ApiLeafAtoms()

Creates new pair iterator that requires reset() before beginning iteration.

Method Detail

setBox

public void setBox(Box box)

Conditions iterator to return all leaf-atom pairs from the given box.

Specified by:

setBox in interface AtomsetIteratorBoxDependent

Throws:

java.lang.NullPointerException - if the Box is null