dmlc::DataIter< DType > Class Template Reference

data iterator interface this is not a C++ style iterator, but nice for data pulling:) This interface is used to pull in the data The system can do some useful tricks for you like pre-fetching from disk and pre-computation. More...

#include <data.h>

Inheritance diagram for dmlc::DataIter< DType >:

Public Member Functions
virtual	~DataIter (void) DMLC_THROW_EXCEPTION
	destructor
virtual void	BeforeFirst (void)=0
	set before first of the item
virtual bool	Next (void)=0
	move to next item
virtual const DType &	Value (void) const =0
	get current data

Detailed Description

template<typename DType>
class dmlc::DataIter< DType >

data iterator interface this is not a C++ style iterator, but nice for data pulling:) This interface is used to pull in the data The system can do some useful tricks for you like pre-fetching from disk and pre-computation.

Usage example:

itr->BeforeFirst();
while (itr->Next()) {
   const DType &batch = itr->Value();
   // some computations
}

Template Parameters

DType

the data type

Member Function Documentation

BeforeFirst()

template<typename DType >

virtual void dmlc::DataIter< DType >::BeforeFirst ( void  )

pure virtual

set before first of the item

Implemented in dmlc::data::DensifyParser< IndexType >, xgboost.data::detail::SingleBatchDataIter< DType >, xgboost.data::detail::SingleBatchDataIter< ArrayAdapterBatch >, xgboost.data::detail::SingleBatchDataIter< CSCAdapterBatch >, xgboost.data::detail::SingleBatchDataIter< CSCArrayAdapterBatch >, xgboost.data::detail::SingleBatchDataIter< CSRAdapterBatch >, xgboost.data::detail::SingleBatchDataIter< CSRArrayAdapterBatch >, xgboost.data::detail::SingleBatchDataIter< DataTableAdapterBatch >, xgboost.data::detail::SingleBatchDataIter< DenseAdapterBatch >, xgboost.data::FileAdapter, xgboost.data::IteratorAdapter< DataIterHandle, XGBCallbackDataIterNext, XGBoostBatchCSR >, xgboost.data::RecordBatchesIterAdapter, dmlc::data::BasicRowIter< IndexType, DType >, dmlc::data::ParquetParser< IndexType, DType >, dmlc::data::TextParserBase< IndexType, DType >, and dmlc::data::TextParserBase< IndexType, real_t >.

Next()

template<typename DType >

virtual bool dmlc::DataIter< DType >::Next ( void  )

pure virtual

move to next item

Implemented in dmlc::data::DensifyParser< IndexType >, xgboost.data::detail::SingleBatchDataIter< DType >, xgboost.data::detail::SingleBatchDataIter< ArrayAdapterBatch >, xgboost.data::detail::SingleBatchDataIter< CSCAdapterBatch >, xgboost.data::detail::SingleBatchDataIter< CSCArrayAdapterBatch >, xgboost.data::detail::SingleBatchDataIter< CSRAdapterBatch >, xgboost.data::detail::SingleBatchDataIter< CSRArrayAdapterBatch >, xgboost.data::detail::SingleBatchDataIter< DataTableAdapterBatch >, xgboost.data::detail::SingleBatchDataIter< DenseAdapterBatch >, xgboost.data::FileAdapter, xgboost.data::IteratorAdapter< DataIterHandle, XGBCallbackDataIterNext, XGBoostBatchCSR >, xgboost.data::RecordBatchesIterAdapter, dmlc::data::BasicRowIter< IndexType, DType >, dmlc::data::ParserImpl< IndexType, DType >, and dmlc::data::ParserImpl< IndexType, real_t >.

Value()

template<typename DType >

virtual const DType & dmlc::DataIter< DType >::Value ( void  ) const

pure virtual

get current data

Implemented in dmlc::data::DensifyParser< IndexType >, xgboost.data::CSRAdapter, xgboost.data::DenseAdapter, xgboost.data::ArrayAdapter, xgboost.data::CSRArrayAdapter, xgboost.data::CSCAdapter, xgboost.data::CSCArrayAdapter, xgboost.data::DataTableAdapter, xgboost.data::FileAdapter, xgboost.data::IteratorAdapter< DataIterHandle, XGBCallbackDataIterNext, XGBoostBatchCSR >, xgboost.data::RecordBatchesIterAdapter, dmlc::data::BasicRowIter< IndexType, DType >, dmlc::data::ParserImpl< IndexType, DType >, and dmlc::data::ParserImpl< IndexType, real_t >.

---

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

• External/xgboost/dmlc-core/include/dmlc/data.h