dmlc::io::SingleThreadedInputSplit Class Reference

provides a single threaded input split Useful for debugging purposes. Be cautious of use for production use cases, as this is much less performant compared to ThreadedInputSplit More...

#include <single_threaded_input_split.h>

Inheritance diagram for dmlc::io::SingleThreadedInputSplit:

Public Member Functions
	SingleThreadedInputSplit (InputSplitBase *base, const size_t batch_size)
bool	NextProducer (InputSplitBase::Chunk **dptr)
void	BeforeFirstProducer ()
virtual void	BeforeFirst ()
	reset the position of InputSplit to beginning
virtual void	HintChunkSize (size_t chunk_size)
	hint the inputsplit how large the chunk size it should return when implementing NextChunk this is a hint so may not be enforced, but InputSplit will try adjust its internal buffer size to the hinted value
virtual bool	NextRecord (Blob *out_rec)
	get the next record, the returning value is valid until next call to NextRecord, NextChunk or NextBatch caller can modify the memory content of out_rec
virtual bool	NextChunk (Blob *out_chunk)
	get a chunk of memory that can contain multiple records, the caller needs to parse the content of the resulting chunk, for text file, out_chunk can contain data of multiple lines for recordio, out_chunk can contain multiple records(including headers)
virtual size_t	GetTotalSize (void)
	get the total size of the InputSplit
virtual void	ResetPartition (unsigned part_index, unsigned num_parts)
	reset the Input split to a certain part id, The InputSplit will be pointed to the head of the new specified segment. This feature may not be supported by every implementation of InputSplit.
Public Member Functions inherited from dmlc::InputSplit
virtual bool	NextBatch (Blob *out_chunk, size_t)
	get a chunk of memory that can contain multiple records, with hint for how many records is needed, the caller needs to parse the content of the resulting chunk, for text file, out_chunk can contain data of multiple lines for recordio, out_chunk can contain multiple records(including headers)
virtual	~InputSplit (void) DMLC_THROW_EXCEPTION
	destructor

Additional Inherited Members
Static Public Member Functions inherited from dmlc::InputSplit
static InputSplit *	Create (const char *uri, unsigned part_index, unsigned num_parts, const char *type)
	factory function: create input split given a uri
static InputSplit *	Create (const char *uri, const char *index_uri, unsigned part_index, unsigned num_parts, const char *type, const bool shuffle=false, const int seed=0, const size_t batch_size=256, const bool recurse_directories=false)
	factory function: create input split given a uri for input and index

Detailed Description

provides a single threaded input split Useful for debugging purposes. Be cautious of use for production use cases, as this is much less performant compared to ThreadedInputSplit

Member Function Documentation

BeforeFirst()

virtual void dmlc::io::SingleThreadedInputSplit::BeforeFirst ( )

inlinevirtual

reset the position of InputSplit to beginning

Implements dmlc::InputSplit.

GetTotalSize()

virtual size_t dmlc::io::SingleThreadedInputSplit::GetTotalSize ( void  )

inlinevirtual

get the total size of the InputSplit

Implements dmlc::InputSplit.

HintChunkSize()

virtual void dmlc::io::SingleThreadedInputSplit::HintChunkSize ( size_t  )

inlinevirtual

hint the inputsplit how large the chunk size it should return when implementing NextChunk this is a hint so may not be enforced, but InputSplit will try adjust its internal buffer size to the hinted value

Reimplemented from dmlc::InputSplit.

NextChunk()

virtual bool dmlc::io::SingleThreadedInputSplit::NextChunk ( Blob *  out_chunk )

inlinevirtual

get a chunk of memory that can contain multiple records, the caller needs to parse the content of the resulting chunk, for text file, out_chunk can contain data of multiple lines for recordio, out_chunk can contain multiple records(including headers)

This function ensures there won't be partial record in the chunk caller can modify the memory content of out_chunk, the memory is valid until next call to NextRecord, NextChunk or NextBatch

Usually NextRecord is sufficient, NextChunk can be used by some multi-threaded parsers to parse the input content

Parameters

out_chunk

used to store the result

Returns

true if we can successfully get next record false if we reached end of split

See also

InputSplit::Create for definition of record

RecordIOChunkReader to parse recordio content from out_chunk

Implements dmlc::InputSplit.

NextRecord()

virtual bool dmlc::io::SingleThreadedInputSplit::NextRecord ( Blob *  out_rec )

inlinevirtual

get the next record, the returning value is valid until next call to NextRecord, NextChunk or NextBatch caller can modify the memory content of out_rec

For text, out_rec contains a single line For recordio, out_rec contains one record content(with header striped)

Parameters

out_rec

used to store the result

Returns

true if we can successfully get next record false if we reached end of split

See also

InputSplit::Create for definition of record

Implements dmlc::InputSplit.

ResetPartition()

virtual void dmlc::io::SingleThreadedInputSplit::ResetPartition ( unsigned  part_index, unsigned  num_parts  )

inlinevirtual

reset the Input split to a certain part id, The InputSplit will be pointed to the head of the new specified segment. This feature may not be supported by every implementation of InputSplit.

Parameters

part_index	The part id of the new input.
num_parts	The total number of parts.

Implements dmlc::InputSplit.

---

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

• External/xgboost/dmlc-core/src/io/single_threaded_input_split.h