Package etomica.potential

Class PotentialMaster.AtomIterator0

java.lang.Object

etomica.potential.PotentialMaster.AtomIterator0

All Implemented Interfaces:

AtomLeafsetIterator, AtomsetIterator, AtomsetIteratorBasisDependent, AtomsetIteratorTargetable

Enclosing class:

PotentialMaster

public static class PotentialMaster.AtomIterator0
extends java.lang.Object
implements AtomsetIteratorBasisDependent

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	finished
protected AtomArrayList	list

Constructor Summary

Constructors

Constructor	Description
AtomIterator0()

Method Summary

Modifier and Type	Method	Description
int	basisSize()	Indicates the size of the basis needed to set the iterator.
boolean	haveTarget(IAtom target)	Returns true if the iterator with its current basis would return an iterate for the given target.
int	nBody()	Returns the number of atoms given in each iterate, i.e., the size of the atom array returned with each call to next().
IAtomList	next()	Returns the next AtomSet iterate, or null if hasNext() is false.
void	reset()	Resets the iterator to loop through its iterates again.
void	setBasis(IMoleculeList atoms)	Identifies the atoms that form the basis for iteration, such that the childList atoms of those given will form the iterates.
void	setTarget(IAtom target)
int	size()	The number of iterates returned by this iterator in its current state.
void	unset()	Puts iterator in a state in which hasNext() returns false.

Methods inherited from class java.lang.Object

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

Field Detail

list

protected final AtomArrayList list

finished

protected boolean finished

Constructor Detail

AtomIterator0

public AtomIterator0()

Method Detail

setTarget

public void setTarget(IAtom target)

Specified by:

setTarget in interface AtomsetIteratorTargetable

nBody

public int nBody()

Description copied from interface: AtomsetIterator

Returns the number of atoms given in each iterate, i.e., the size of the atom array returned with each call to next().

Specified by:

nBody in interface AtomsetIterator

Returns:

next

public IAtomList next()

Description copied from interface: AtomLeafsetIterator

Returns the next AtomSet iterate, or null if hasNext() is false.

Specified by:

next in interface AtomLeafsetIterator

reset

public void reset()

Description copied from interface: AtomsetIterator

Resets the iterator to loop through its iterates again.

Specified by:

reset in interface AtomsetIterator

size

public int size()

Description copied from interface: AtomsetIterator

The number of iterates returned by this iterator in its current state.

Specified by:

size in interface AtomsetIterator

unset

public void unset()

Description copied from interface: AtomsetIterator

Puts iterator in a state in which hasNext() returns false.

Specified by:

unset in interface AtomsetIterator

setBasis

public void setBasis(IMoleculeList atoms)

Description copied from interface: AtomsetIteratorBasisDependent

Identifies the atoms that form the basis for iteration, such that the childList atoms of those given will form the iterates.

Specified by:

setBasis in interface AtomsetIteratorBasisDependent

Parameters:

atoms - 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.

basisSize

public int basisSize()

Description copied from interface: AtomsetIteratorBasisDependent

Indicates the size of the basis needed to set the iterator. The length of the array given to setBasis should be this value.

Specified by:

basisSize in interface AtomsetIteratorBasisDependent

Returns:

the size of the basis for this iterator.

haveTarget

public boolean haveTarget(IAtom target)

Description copied from interface: AtomsetIteratorBasisDependent

Returns true if the iterator with its current basis would return an iterate for the given target.

Specified by:

haveTarget in interface AtomsetIteratorBasisDependent