EarlyTerminationDataSetIterator (deeplearning4j-nn 0.9.1 API)

java.lang.Object
- org.deeplearning4j.datasets.iterator.EarlyTerminationDataSetIterator

All Implemented Interfaces:

Serializable, Iterator<org.nd4j.linalg.dataset.DataSet>, org.nd4j.linalg.dataset.api.iterator.DataSetIterator
```
public class EarlyTerminationDataSetIterator
extends Object
implements org.nd4j.linalg.dataset.api.iterator.DataSetIterator
```
Builds an iterator that terminates once the number of minibatches returned with .next() is equal to a specified number Note that a call to .next(num) is counted as a call to return a minibatch regardless of the value of num This essentially restricts the data to this specified number of minibatches.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`EarlyTerminationDataSetIterator(org.nd4j.linalg.dataset.api.iterator.DataSetIterator underlyingIterator, int terminationPoint)` Constructor takes the iterator to wrap and the number of minibatches after which the call to hasNext() will return false

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`asyncSupported()`
`int`	`batch()`
`int`	`cursor()`
`List<String>`	`getLabels()`
`org.nd4j.linalg.dataset.api.DataSetPreProcessor`	`getPreProcessor()`
`boolean`	`hasNext()`
`int`	`inputColumns()`
`org.nd4j.linalg.dataset.DataSet`	`next()`
`org.nd4j.linalg.dataset.DataSet`	`next(int num)`
`int`	`numExamples()`
`void`	`remove()`
`void`	`reset()`
`boolean`	`resetSupported()`
`void`	`setPreProcessor(org.nd4j.linalg.dataset.api.DataSetPreProcessor preProcessor)`
`int`	`totalExamples()`
`int`	`totalOutcomes()`

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
  - EarlyTerminationDataSetIterator
```
public EarlyTerminationDataSetIterator(org.nd4j.linalg.dataset.api.iterator.DataSetIterator underlyingIterator,
                                       int terminationPoint)
```
    Constructor takes the iterator to wrap and the number of minibatches after which the call to hasNext() will return false
    
    Parameters:
    
    underlyingIterator, - iterator to wrap
    
    terminationPoint, - minibatches after which hasNext() will return false
- Method Detail
  - next
```
public org.nd4j.linalg.dataset.DataSet next(int num)
```
    Specified by:
    
    next in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - totalExamples
```
public int totalExamples()
```
    Specified by:
    
    totalExamples in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - inputColumns
```
public int inputColumns()
```
    Specified by:
    
    inputColumns in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - totalOutcomes
```
public int totalOutcomes()
```
    Specified by:
    
    totalOutcomes in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - resetSupported
```
public boolean resetSupported()
```
    Specified by:
    
    resetSupported in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - asyncSupported
```
public boolean asyncSupported()
```
    Specified by:
    
    asyncSupported in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - batch
```
public int batch()
```
    Specified by:
    
    batch in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - cursor
```
public int cursor()
```
    Specified by:
    
    cursor in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - numExamples
```
public int numExamples()
```
    Specified by:
    
    numExamples in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - setPreProcessor
```
public void setPreProcessor(org.nd4j.linalg.dataset.api.DataSetPreProcessor preProcessor)
```
    Specified by:
    
    setPreProcessor in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - getPreProcessor
```
public org.nd4j.linalg.dataset.api.DataSetPreProcessor getPreProcessor()
```
    Specified by:
    
    getPreProcessor in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - getLabels
```
public List<String> getLabels()
```
    Specified by:
    
    getLabels in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<org.nd4j.linalg.dataset.DataSet>
  - next
```
public org.nd4j.linalg.dataset.DataSet next()
```
    Specified by:
    
    next in interface Iterator<org.nd4j.linalg.dataset.DataSet>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<org.nd4j.linalg.dataset.DataSet>

Class EarlyTerminationDataSetIterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Constructor Detail

EarlyTerminationDataSetIterator

Method Detail

next

totalExamples

inputColumns

totalOutcomes

resetSupported

asyncSupported

reset

batch

cursor

numExamples

setPreProcessor

getPreProcessor

getLabels

hasNext

next

remove