org.deeplearning4j.text.corpora.treeparser

Class TreeIterator

java.lang.Object

org.deeplearning4j.text.corpora.treeparser.TreeIterator

All Implemented Interfaces:

java.util.Iterator<java.util.List<Tree>>

public class TreeIterator
extends java.lang.Object
implements java.util.Iterator<java.util.List<Tree>>

Tree iterator: iterate over sentences returning trees with labels and everything already preset

Constructor Summary

Constructors

Constructor and Description
TreeIterator(LabelAwareSentenceIterator sentenceIterator, java.util.List<java.lang.String> labels)
TreeIterator(LabelAwareSentenceIterator sentenceIterator, java.util.List<java.lang.String> labels, TreeVectorizer treeVectorizer)
TreeIterator(LabelAwareSentenceIterator sentenceIterator, java.util.List<java.lang.String> labels, TreeVectorizer treeVectorizer, int batchSize)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Returns true if the iteration has more elements.
java.util.List<Tree>	next() Returns the next element in the iteration.
void	remove() Removes from the underlying collection the last element returned by this iterator (optional operation).

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

Constructor Detail

TreeIterator

public TreeIterator(LabelAwareSentenceIterator sentenceIterator,
                    java.util.List<java.lang.String> labels,
                    TreeVectorizer treeVectorizer,
                    int batchSize)

TreeIterator

public TreeIterator(LabelAwareSentenceIterator sentenceIterator,
                    java.util.List<java.lang.String> labels,
                    TreeVectorizer treeVectorizer)

TreeIterator

public TreeIterator(LabelAwareSentenceIterator sentenceIterator,
                    java.util.List<java.lang.String> labels)
             throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

hasNext

public boolean hasNext()

Returns true if the iteration has more elements. (In other words, returns true if next() would return an element rather than throwing an exception.)

Specified by:

hasNext in interface java.util.Iterator<java.util.List<Tree>>

Returns:

true if the iteration has more elements

next

public java.util.List<Tree> next()

Returns the next element in the iteration.

Specified by:

next in interface java.util.Iterator<java.util.List<Tree>>

Returns:

the next element in the iteration

remove

public void remove()

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next(). The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.

Specified by:

remove in interface java.util.Iterator<java.util.List<Tree>>

Throws:

java.lang.UnsupportedOperationException - if the remove operation is not supported by this iterator

java.lang.IllegalStateException - if the next method has not yet been called, or the remove method has already been called after the last call to the next method