CFTree.LeafIterator (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- elki.clustering.hierarchical.birch.CFTree.LeafIterator

All Implemented Interfaces:

Iter

Enclosing class:

CFTree
```
public static class CFTree.LeafIterator
extends java.lang.Object
implements Iter
```
Iterator over leaf nodes.

Author:

Erich Schubert

Field Summary

Fields
Modifier and Type Field Description

private ClusteringFeature current
Current leaf entry.

private java.util.ArrayList<ClusteringFeature> queue
Queue of open ends.

Constructor Summary

Constructors
Modifier Constructor Description

private LeafIterator(CFTree.TreeNode root)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Iter`	`advance()`	Moves the iterator forward to the next entry.
`ClusteringFeature`	`get()`	Get the current leaf.
`boolean`	`valid()`	Returns true if the iterator currently points to a valid object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - queue
```
private java.util.ArrayList<ClusteringFeature> queue
```
    Queue of open ends.
  - current
```
private ClusteringFeature current
```
    Current leaf entry.
- Constructor Detail
  - LeafIterator
```
private LeafIterator(CFTree.TreeNode root)
```
    Constructor.
    
    Parameters:
    
    root - Root node
- Method Detail
  - valid
```
public boolean valid()
```
    Description copied from interface: Iter
    
    Returns true if the iterator currently points to a valid object.
    
    Specified by:
    
    valid in interface Iter
    
    Returns:
    
    a boolean value, whether the position is valid.
  - get
```
public ClusteringFeature get()
```
    Get the current leaf.
    
    Returns:
    
    Current leaf (if valid, null otherwise).
  - advance
```
public Iter advance()
```
    Description copied from interface: Iter
    
    Moves the iterator forward to the next entry.
    
    Specified by:
    
    advance in interface Iter
    
    Returns:
    
    The iterator itself.