A Stream that operates on fixed region of memory This class allows us to read/write from/to a fixed memory region.
More...
#include <memory_io.h>
|
| MemoryFixedSizeStream (void *p_buffer, size_t buffer_size) |
| constructor More...
|
|
virtual size_t | Read (void *ptr, size_t size) |
| reads data from a stream More...
|
|
virtual void | Write (const void *ptr, size_t size) |
| writes data to a stream More...
|
|
virtual void | Seek (size_t pos) |
| seek to certain position of the file More...
|
|
virtual size_t | Tell (void) |
| tell the position of the stream More...
|
|
virtual | ~SeekStream (void) |
|
virtual | ~Stream (void) |
| virtual destructor More...
|
|
template<typename T > |
void | Write (const T &data) |
| writes a data to stream. More...
|
|
template<typename T > |
bool | Read (T *out_data) |
| loads a data from stream. More...
|
|
template<typename T > |
void | WriteArray (const T *data, size_t num_elems) |
| Endian aware write array of data. More...
|
|
template<typename T > |
bool | ReadArray (T *data, size_t num_elems) |
| Endian aware read array of data. More...
|
|
|
static SeekStream * | CreateForRead (const char *uri, bool allow_null=false) |
| generic factory function create an SeekStream for read only, the stream will close the underlying files upon deletion error will be reported and the system will exit when create failed More...
|
|
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 More...
|
|
A Stream that operates on fixed region of memory This class allows us to read/write from/to a fixed memory region.
dmlc::MemoryFixedSizeStream::MemoryFixedSizeStream |
( |
void * |
p_buffer, |
|
|
size_t |
buffer_size |
|
) |
| |
|
inline |
constructor
- Parameters
-
p_buffer | the head pointer of the memory region. |
buffer_size | the size of the memorybuffer |
virtual size_t dmlc::MemoryFixedSizeStream::Read |
( |
void * |
ptr, |
|
|
size_t |
size |
|
) |
| |
|
inlinevirtual |
reads data from a stream
- Parameters
-
ptr | pointer to a memory buffer |
size | block size |
- Returns
- the size of data read
Implements dmlc::Stream.
virtual void dmlc::MemoryFixedSizeStream::Seek |
( |
size_t |
pos | ) |
|
|
inlinevirtual |
virtual size_t dmlc::MemoryFixedSizeStream::Tell |
( |
void |
| ) |
|
|
inlinevirtual |
virtual void dmlc::MemoryFixedSizeStream::Write |
( |
const void * |
ptr, |
|
|
size_t |
size |
|
) |
| |
|
inlinevirtual |
writes data to a stream
- Parameters
-
ptr | pointer to a memory buffer |
size | block size |
Implements dmlc::Stream.
The documentation for this struct was generated from the following file:
- /work/mxnet/3rdparty/dmlc-core/include/dmlc/memory_io.h