Package etomica.atom.iterator

Class ApiIntergroupExchange

java.lang.Object

etomica.atom.iterator.ApiIntergroup

etomica.atom.iterator.ApiIntergroupExchange

All Implemented Interfaces:

AtomLeafsetIterator, AtomsetIterator, AtomsetIteratorBasisDependent, AtomsetIteratorTargetable

public class ApiIntergroupExchange
extends ApiIntergroup

Field Summary

Fields

Modifier and Type	Field	Description
protected int	aiInnerSize
protected int	aiOuterSize
protected int	atom1
protected int	atom2
protected int	monomer1
protected int	P
protected IAtom	startAtom0
protected IAtom	startAtom1

Fields inherited from class etomica.atom.iterator.ApiIntergroup

aiInner, aiOuter, atomSetSinglet, needSetupIterators, pair, targetAtom

Constructor Summary

Constructors

Constructor	Description
ApiIntergroupExchange(int P)

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.
void	setBasis(IMoleculeList basisAtoms)	Specifies the basis, which identifies the atoms subject to iteration.
int	size()	Returns the number of pairs given by this iterator.

Methods inherited from class etomica.atom.iterator.ApiIntergroup

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

Methods inherited from class java.lang.Object

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

Field Detail

P

protected final int P

monomer1

protected int monomer1

atom1

protected int atom1

atom2

protected int atom2

startAtom0

protected IAtom startAtom0

startAtom1

protected IAtom startAtom1

aiOuterSize

protected int aiOuterSize

aiInnerSize

protected int aiInnerSize

Constructor Detail

ApiIntergroupExchange

public ApiIntergroupExchange(int P)

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

setBasis

public void setBasis(IMoleculeList basisAtoms)

Description copied from class: ApiIntergroup

Specifies the basis, which identifies the atoms subject to iteration. The given atomSet must be of length 2. The first atom in the set specifies the basis for the outer-loop iteration, and second atom specifies the basis for the inner-loop iteration. In each case, if the basis atom is not a leaf atom, its children will be the subject of iteration. If the basis atom is a leaf, it will itself be the iterate. If given atomset is null iterator will give no iterates until a proper basis is specified via another call to this method.

Specified by:

setBasis in interface AtomsetIteratorBasisDependent

Overrides:

setBasis in class ApiIntergroup

Parameters:

basisAtoms - The basis atoms; a null basis will condition the iterator to give no iterates until a valid basis is specified via another call to this method.