Package etomica.atom.iterator

Class ApiIntergroupCoupled

java.lang.Object

etomica.atom.iterator.ApiIntergroup

etomica.atom.iterator.ApiIntergroupCoupled

All Implemented Interfaces:

AtomLeafsetIterator, AtomsetIterator, AtomsetIteratorBasisDependent, AtomsetIteratorTargetable

public class ApiIntergroupCoupled
extends ApiIntergroup

Iterator that returns coupled iterates; the first pair contains the first atom from each basis. The second pair has the second atom from each basis.

Field Summary

Fields inherited from class etomica.atom.iterator.ApiIntergroup

aiInner, aiOuter, atomSetSinglet, needSetupIterators, pair, targetAtom

Constructor Summary

Constructors

Constructor	Description
ApiIntergroupCoupled()
ApiIntergroupCoupled(AtomIteratorBasis outer, AtomIteratorBasis inner)

Method Summary

Modifier and Type	Method	Description
IAtomList	next()	Returns the next pair of atoms.
void	reset()	Resets the iterator to loop through its iterates again.
int	size()	Returns the number of pairs given by this iterator.

Methods inherited from class etomica.atom.iterator.ApiIntergroup

basisSize, getInnerIterator, getOuterIterator, haveTarget, nBody, setBasis, setTarget, setupIterators, unset

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiIntergroupCoupled

public ApiIntergroupCoupled()

ApiIntergroupCoupled

public ApiIntergroupCoupled(AtomIteratorBasis outer,
                            AtomIteratorBasis inner)

Method Detail

size

public int size()

Returns the number of pairs given by this iterator. Not dependent on state of hasNext.

Specified by:

size in interface AtomsetIterator

Overrides:

size in class ApiIntergroup

next

public IAtomList next()

Returns the next pair of atoms. The same AtomPair instance is returned every time, but the Atoms it holds are (of course) different for each iterate.

Specified by:

next in interface AtomLeafsetIterator

Overrides:

next in class ApiIntergroup

reset

public void reset()

Description copied from interface: AtomsetIterator

Resets the iterator to loop through its iterates again.

Specified by:

reset in interface AtomsetIterator

Overrides:

reset in class ApiIntergroup