mxnet
Public Member Functions | List of all members
dmlc::ThreadedIter< DType >::Producer Class Referenceabstract

producer class interface that threaditer used as source to preduce the content More...

#include <threadediter.h>

Collaboration diagram for dmlc::ThreadedIter< DType >::Producer:
Collaboration graph

Public Member Functions

virtual ~Producer ()=default
 
virtual void BeforeFirst (void)
 reset the producer to beginning More...
 
virtual bool Next (DType **inout_dptr)=0
 load the data content into DType, the caller can pass in NULL or an existing address when inout_dptr is NULL: producer need to allocate a DType and fill the content when inout_dptr is specified producer takes need to fill the content into address specified inout_dptr, or delete the one and create a new one More...
 

Detailed Description

template<typename DType>
class dmlc::ThreadedIter< DType >::Producer

producer class interface that threaditer used as source to preduce the content

Constructor & Destructor Documentation

template<typename DType >
virtual dmlc::ThreadedIter< DType >::Producer::~Producer ( )
virtualdefault

Member Function Documentation

template<typename DType >
virtual void dmlc::ThreadedIter< DType >::Producer::BeforeFirst ( void  )
inlinevirtual

reset the producer to beginning

template<typename DType >
virtual bool dmlc::ThreadedIter< DType >::Producer::Next ( DType **  inout_dptr)
pure virtual

load the data content into DType, the caller can pass in NULL or an existing address when inout_dptr is NULL: producer need to allocate a DType and fill the content when inout_dptr is specified producer takes need to fill the content into address specified inout_dptr, or delete the one and create a new one

Parameters
inout_dptrused to pass in the data holder cell and return the address of the cell filled
Returns
true if there is next record, false if we reach the end

The documentation for this class was generated from the following file: