org.nd4j.linalg.dataset.adapter

Class SingletonMultiDataSetIterator

java.lang.Object

org.nd4j.linalg.dataset.adapter.SingletonMultiDataSetIterator

All Implemented Interfaces:

Serializable, Iterator<MultiDataSet>, MultiDataSetIterator

public class SingletonMultiDataSetIterator
extends Object
implements MultiDataSetIterator

A very simple adapter class for converting a single MultiDataSet to a MultiDataSetIterator. Returns a single MultiDataSet as-is, once for each epoch

Author:

Alex Black

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SingletonMultiDataSetIterator(MultiDataSet multiDataSet)

Method Summary

Modifier and Type	Method and Description
boolean	asyncSupported() Does this MultiDataSetIterator support asynchronous prefetching of multiple MultiDataSet objects? Most MultiDataSetIterators do, but in some cases it may not make sense to wrap this iterator in an iterator that does asynchronous prefetching.
MultiDataSetPreProcessor	getPreProcessor() Get the MultiDataSetPreProcessor, if one has previously been set.
boolean	hasNext()
MultiDataSet	next()
MultiDataSet	next(int num) Fetch the next 'num' examples.
void	remove()
void	reset() Resets the iterator back to the beginning
boolean	resetSupported() Is resetting supported by this DataSetIterator? Many DataSetIterators do support resetting, but some don't
void	setPreProcessor(MultiDataSetPreProcessor preProcessor) Set the preprocessor to be applied to each MultiDataSet, before each MultiDataSet is returned.

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

SingletonMultiDataSetIterator

public SingletonMultiDataSetIterator(MultiDataSet multiDataSet)

Parameters:

multiDataSet - The underlying MultiDataSet to return

Method Detail

next

public MultiDataSet next(int num)

Description copied from interface: MultiDataSetIterator

Fetch the next 'num' examples. Similar to the next method, but returns a specified number of examples

Specified by:

next in interface MultiDataSetIterator

Parameters:

num - Number of examples to fetch

setPreProcessor

public void setPreProcessor(MultiDataSetPreProcessor preProcessor)

Description copied from interface: MultiDataSetIterator

Set the preprocessor to be applied to each MultiDataSet, before each MultiDataSet is returned.

Specified by:

setPreProcessor in interface MultiDataSetIterator

Parameters:

preProcessor - MultiDataSetPreProcessor. May be null.

getPreProcessor

public MultiDataSetPreProcessor getPreProcessor()

Description copied from interface: MultiDataSetIterator

Get the MultiDataSetPreProcessor, if one has previously been set. Returns null if no preprocessor has been set

Specified by:

getPreProcessor in interface MultiDataSetIterator

Returns:

Preprocessor

resetSupported

public boolean resetSupported()

Description copied from interface: MultiDataSetIterator

Is resetting supported by this DataSetIterator? Many DataSetIterators do support resetting, but some don't

Specified by:

resetSupported in interface MultiDataSetIterator

Returns:

true if reset method is supported; false otherwise

asyncSupported

public boolean asyncSupported()

Description copied from interface: MultiDataSetIterator

Does this MultiDataSetIterator support asynchronous prefetching of multiple MultiDataSet objects? Most MultiDataSetIterators do, but in some cases it may not make sense to wrap this iterator in an iterator that does asynchronous prefetching. For example, it would not make sense to use asynchronous prefetching for the following types of iterators: (a) Iterators that store their full contents in memory already (b) Iterators that re-use features/labels arrays (as future next() calls will overwrite past contents) (c) Iterators that already implement some level of asynchronous prefetching (d) Iterators that may return different data depending on when the next() method is called

Specified by:

asyncSupported in interface MultiDataSetIterator

Returns:

true if asynchronous prefetching from this iterator is OK; false if asynchronous prefetching should not be used with this iterator

reset

public void reset()

Description copied from interface: MultiDataSetIterator

Resets the iterator back to the beginning

Specified by:

reset in interface MultiDataSetIterator

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<MultiDataSet>

next

public MultiDataSet next()

Specified by:

next in interface Iterator<MultiDataSet>

remove

public void remove()

Specified by:

remove in interface Iterator<MultiDataSet>