org.deeplearning4j.models.sequencevectors.iterators

Class FilteredSequenceIterator<T extends SequenceElement>

java.lang.Object

org.deeplearning4j.models.sequencevectors.iterators.FilteredSequenceIterator<T>

All Implemented Interfaces:

SequenceIterator<T>

public class FilteredSequenceIterator<T extends SequenceElement>
extends Object
implements SequenceIterator<T>

This implementation of SequenceIterator passes each sequence through specified vocabulary, filtering out SequenceElements that are not available in Vocabulary. Please note: nextSequence() method can return empty sequence, if none of elements were found in attached vocabulary.

Author:

raver119@gmail.com

Constructor Summary

Constructors

Constructor and Description
FilteredSequenceIterator(SequenceIterator<T> iterator, VocabCache<T> vocabCache) Creates Filtered SequenceIterator on top of another SequenceIterator and appropriate VocabCache instance

Method Summary

Modifier and Type	Method and Description
boolean	hasMoreSequences() Checks, if there's any more sequences left in underlying iterator
Sequence<T>	nextSequence() Returns filtered sequence, that contains sequence elements from vocabulary only.
void	reset() Resets iterator down to first sequence

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredSequenceIterator

public FilteredSequenceIterator(@NonNull
                                SequenceIterator<T> iterator,
                                @NonNull
                                VocabCache<T> vocabCache)

Creates Filtered SequenceIterator on top of another SequenceIterator and appropriate VocabCache instance

Parameters:

iterator -

vocabCache -

Method Detail

hasMoreSequences

public boolean hasMoreSequences()

Checks, if there's any more sequences left in underlying iterator

Specified by:

hasMoreSequences in interface SequenceIterator<T extends SequenceElement>

Returns:

nextSequence

public Sequence<T> nextSequence()

Returns filtered sequence, that contains sequence elements from vocabulary only. Please note: it can return empty sequence, if no elements were found in vocabulary

Specified by:

nextSequence in interface SequenceIterator<T extends SequenceElement>

Returns:

reset

public void reset()

Resets iterator down to first sequence

Specified by:

reset in interface SequenceIterator<T extends SequenceElement>