ANIntergroupExchange

java.lang.Object
- etomica.atom.iterator.ANIntergroupExchange

All Implemented Interfaces:

AtomLeafsetIterator, AtomsetIterator, AtomsetIteratorBasisDependent, AtomsetIteratorTargetable
```
public class ANIntergroupExchange
extends java.lang.Object
implements AtomsetIteratorBasisDependent
```

Field Summary

Fields
Modifier and Type	Field	Description
`protected ANIntragroupExchange`	`anIntragroupExchange`
`protected AtomArrayList`	`atoms`
`protected int`	`counter`
`protected MoleculePair`	`moleculePair`
`protected boolean`	`needSetupIterators`
`protected int`	`nLeafAtoms`
`protected int`	`P`
`protected IAtomList`	`pair`
`protected boolean`	`stillOnPolymer0`

Constructor Summary

Constructors
Constructor Description

ANIntergroupExchange(int P)

Constructors
Constructor	Description
`ANIntergroupExchange(int P)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`basisSize()`	Returns 2, indicating that the setBasis method expects an array of two atoms.
`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 basisMolecules)`	Specifies the basis, which identifies the molecules subject to iteration.
`void`	`setTarget(IAtom newTargetAtom)`
`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
  - atoms
```
protected final AtomArrayList atoms
```
  - moleculePair
```
protected final MoleculePair moleculePair
```
  - counter
```
protected int counter
```
  - nLeafAtoms
```
protected int nLeafAtoms
```
  - needSetupIterators
```
protected boolean needSetupIterators
```
  - P
```
protected final int P
```
  - anIntragroupExchange
```
protected ANIntragroupExchange anIntragroupExchange
```
  - stillOnPolymer0
```
protected boolean stillOnPolymer0
```
  - pair
```
protected IAtomList pair
```
- Constructor Detail
  - ANIntergroupExchange
```
public ANIntergroupExchange(int P)
```
- Method Detail
  - 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
  - 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
  - nBody
```
public final 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
  - setTarget
```
public void setTarget(IAtom newTargetAtom)
```
    Specified by:
    
    setTarget in interface AtomsetIteratorTargetable
  - 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
  - setBasis
```
public void setBasis(IMoleculeList basisMolecules)
```
    Specifies the basis, which identifies the molecules subject to iteration.
    
    Specified by:
    
    setBasis in interface AtomsetIteratorBasisDependent
    
    Parameters:
    
    basisMolecules - 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.
  - reset
```
public void reset()
```
    Description copied from interface: AtomsetIterator
    
    Resets the iterator to loop through its iterates again.
    
    Specified by:
    
    reset in interface AtomsetIterator
  - basisSize
```
public int basisSize()
```
    Returns 2, indicating that the setBasis method expects an array of two atoms.
    
    Specified by:
    
    basisSize in interface AtomsetIteratorBasisDependent
    
    Returns:
    
    the size of the basis for this iterator.

Class ANIntergroupExchange

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

atoms

moleculePair

counter

nLeafAtoms

needSetupIterators

P

anIntragroupExchange

stillOnPolymer0

pair

Constructor Detail

ANIntergroupExchange

Method Detail

unset

size

nBody

next

setTarget

haveTarget

setBasis

reset

basisSize