xgboost::common::FixedSizeStream Class Reference

A simple class used to consume ‘dmlc::Stream’ all at once. More...

#include <io.h>

Inheritance diagram for xgboost::common::FixedSizeStream:

Public Member Functions
	FixedSizeStream (PeekableInStream *stream)
size_t	Read (void *dptr, size_t size) override
	reads data from a stream
size_t	PeekRead (void *dptr, size_t size) override
std::size_t	Size () const
std::size_t	Tell () const
void	Seek (size_t pos)
void	Write (const void *, size_t) override
	writes data to a stream
void	Take (std::string *out)
	Take the buffer from ‘FixedSizeStream’. The one in ‘FixedSizeStream’ will be cleared out.
Public Member Functions inherited from xgboost::common::PeekableInStream
	PeekableInStream (dmlc::Stream *strm)
size_t	Read (void *dptr, size_t size) override
	reads data from a stream
void	Write (const void *, size_t) override
	writes data to a stream
Public Member Functions inherited from dmlc::Stream
virtual	~Stream (void)
	virtual destructor
template<typename T >
void	Write (const T &data)
	writes a data to stream.
template<typename T >
bool	Read (T *out_data)
	loads a data from stream.
template<typename T >
void	WriteArray (const T *data, size_t num_elems)
	Endian aware write array of data.
template<typename T >
bool	ReadArray (T *data, size_t num_elems)
	Endian aware read array of data.

Additional Inherited Members
Static Public Member Functions inherited from dmlc::Stream
static Stream *	Create (const char *uri, const char *const flag, bool allow_null=false)
	generic factory function create an stream, the stream will close the underlying files upon deletion

Detailed Description

A simple class used to consume ‘dmlc::Stream’ all at once.

With it one can load the rabit checkpoint into a known size string buffer.

Member Function Documentation

PeekRead()

size_t xgboost::common::FixedSizeStream::PeekRead ( void *  dptr, size_t  size  )

overridevirtual

Reimplemented from xgboost::common::PeekableInStream.

Read()

size_t xgboost::common::FixedSizeStream::Read ( void *  ptr, size_t  size  )

overridevirtual

reads data from a stream

Parameters

ptr	pointer to a memory buffer
size	block size

Returns

the size of data read

Implements dmlc::Stream.

Write()

void xgboost::common::FixedSizeStream::Write ( const void *  ptr, size_t  size  )

inlineoverridevirtual

writes data to a stream

Parameters

ptr	pointer to a memory buffer
size	block size

Implements dmlc::Stream.

---

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

• External/xgboost/src/common/io.h
• External/xgboost/src/common/io.cc