Package etomica.molecule.iterator

Class MpiInterArrayList

java.lang.Object

etomica.molecule.iterator.MpiInterArrayList

All Implemented Interfaces:

AtomsetIterator, MoleculesetIterator, java.io.Serializable

public class MpiInterArrayList
extends java.lang.Object
implements MoleculesetIterator, java.io.Serializable

Returns all pairs formed from two different untabbed lists of molecules. Incorrect behavior will result if both lists refer to the same instance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MpiInterArrayList()	Construct iterator with an empty lists.
MpiInterArrayList(IMoleculeList outerList, IMoleculeList innerList)	Constructs iterator to return pairs from the given lists.

Method Summary

Modifier and Type	Method	Description
IMoleculeList	getInnerList()	Returns the inner list used to generate the pairs.
IMoleculeList	getOuterList()	Returns the outer list used to generate the pairs.
int	nBody()	Returns 2, indicating that this is a pair iterator
IMoleculeList	next()	Returns the next iterate pair.
void	reset()	Sets iterator in condition to begin iteration.
void	setInnerList(IMoleculeList newList)	Sets the list that will be used to generate the pairs.
void	setOuterList(IMoleculeList newList)	Sets the list that will be used to generate the pairs.
int	size()	Returns the number of iterates, which is list.size*(list.size-1)/2
void	unset()	Sets iterator such that hasNext is false.

Methods inherited from class java.lang.Object

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

Constructor Detail

MpiInterArrayList

public MpiInterArrayList()

Construct iterator with an empty lists. No iterates will be given until non-empty lists are specified via setList.

MpiInterArrayList

public MpiInterArrayList(IMoleculeList outerList,
                         IMoleculeList innerList)

Constructs iterator to return pairs from the given lists. Requires reset() before first use.

Throws:

java.lang.IllegalArgumentException - if both lists refer to the same instance

Method Detail

reset

public void reset()

Sets iterator in condition to begin iteration.

Specified by:

reset in interface AtomsetIterator

Throws:

java.lang.IllegalStateException - if outer and inner lists have been set to the same instance

unset

public void unset()

Sets iterator such that hasNext is false.

Specified by:

unset in interface AtomsetIterator

next

public IMoleculeList next()

Returns the next iterate pair. Returns null if there are no more iterates.

Specified by:

next in interface MoleculesetIterator

size

public int size()

Returns the number of iterates, which is list.size*(list.size-1)/2

Specified by:

size in interface AtomsetIterator

nBody

public int nBody()

Returns 2, indicating that this is a pair iterator

Specified by:

nBody in interface AtomsetIterator

Returns:

setOuterList

public void setOuterList(IMoleculeList newList)

Sets the list that will be used to generate the pairs. Must call reset() before beginning iteration.

Parameters:

newList - the new molecule list for iteration

setInnerList

public void setInnerList(IMoleculeList newList)

Sets the list that will be used to generate the pairs. Must call reset() before beginning iteration.

Parameters:

newList - the new molecule list for iteration

getOuterList

public IMoleculeList getOuterList()

Returns the outer list used to generate the pairs.

getInnerList

public IMoleculeList getInnerList()

Returns the inner list used to generate the pairs.