NeighborIterator (Mallet 2 API)

java.lang.Object
- cc.mallet.cluster.iterator.NeighborIterator

All Implemented Interfaces:

java.util.Iterator<Instance>

Direct Known Subclasses:

AllPairsIterator, PairSampleIterator
```
public abstract class NeighborIterator
extends java.lang.Object
implements java.util.Iterator<Instance>
```
Sample Instances with data objects equal to Neighbors. This class is mainly used to generate training Instances from a true Clustering.

Since:

1.0

Version:

1.0

Author:

"Aron Culotta"

See Also:

InstanceIterator

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  protected Clustering clustering
- Constructor Summary
  
  Constructors
  Constructor Description
  
  NeighborIterator(Clustering clustering)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  protected Clustering getClustering()
  
  void remove()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface java.util.Iterator
    forEachRemaining, hasNext, next

- Field Detail
  - clustering
```
protected Clustering clustering
```
- Constructor Detail
  - NeighborIterator
```
public NeighborIterator(Clustering clustering)
```
    Parameters:
    
    clustering - A true Clustering.
- Method Detail
  - getClustering
```
protected Clustering getClustering()
```
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface java.util.Iterator<Instance>