Package etomica.atom.iterator

Class ApiIntergroupIntraSpecies

java.lang.Object

etomica.atom.iterator.ApiIntergroup

etomica.atom.iterator.ApiIntergroupIntraSpecies

All Implemented Interfaces:

AtomLeafsetIterator, AtomsetIterator, AtomsetIteratorBasisDependent, AtomsetIteratorTargetable

public class ApiIntergroupIntraSpecies
extends ApiIntergroup

Iterator that returns pairs formed using two different basis atoms, so that the iterates are taken from two different groups. This subclass of ApiIntergroup is specifically designed to return atoms of different types from different molecules of the same species. For methane, it would return both C-H and H-C.

Field Summary

Fields inherited from class etomica.atom.iterator.ApiIntergroup

aiInner, aiOuter, atomSetSinglet, needSetupIterators, pair, targetAtom

Constructor Summary

Constructors

Constructor	Description
ApiIntergroupIntraSpecies(AtomIteratorBasisDependent outer, AtomIteratorBasisDependent inner)	Constructs a pair iterator that returns iterates from the given pairIterator, which is expected to contain two basis-dependent iterators.

Method Summary

Modifier and Type	Method	Description
IAtomList	next()	Returns the next pair of atoms.

Methods inherited from class etomica.atom.iterator.ApiIntergroup

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiIntergroupIntraSpecies

public ApiIntergroupIntraSpecies(AtomIteratorBasisDependent outer,
                                 AtomIteratorBasisDependent inner)

Constructs a pair iterator that returns iterates from the given pairIterator, which is expected to contain two basis-dependent iterators.

Method Detail

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