BitMagic-C++
Public Member Functions | Protected Attributes
bm::decoder_base Class Reference

Base class for all decoding functionality. More...

#include <encoding.h>

Inheritance diagram for bm::decoder_base:
Inheritance graph
[legend]

Public Member Functions

 decoder_base (const unsigned char *buf) BMNOEXCEPT
 
unsigned char get_8 () BMNOEXCEPT
 Reads character from the decoding buffer.
 
size_t size () const BMNOEXCEPT
 Returns size of the current decoding stream.
 
void seek (int delta) BMNOEXCEPT
 change current position
 
void memcpy (unsigned char *dst, size_t count) BMNOEXCEPT
 read bytes from the decode buffer
 
const unsigned char * get_pos () const BMNOEXCEPT
 Return current buffer pointer.
 
void set_pos (const unsigned char *pos) BMNOEXCEPT
 Set current buffer pointer.
 

Protected Attributes

const unsigned char * buf_
 
const unsigned char * start_
 

Detailed Description

Base class for all decoding functionality.

Definition at line 83 of file encoding.h.

Constructor & Destructor Documentation

◆ decoder_base()

bm::decoder_base::decoder_base ( const unsigned char *  buf)
inline

Definition at line 86 of file encoding.h.

Member Function Documentation

◆ get_8()

unsigned char bm::decoder_base::get_8 ( )
inline

◆ get_pos()

const unsigned char * bm::decoder_base::get_pos ( ) const
inline

Return current buffer pointer.

Definition at line 101 of file encoding.h.

Referenced by bm::compressed_collection_deserializer< CBC >::deserialize(), and bm::deseriaizer_base< DEC, BLOCK_IDX >::try_skip().

◆ memcpy()

void bm::decoder_base::memcpy ( unsigned char *  dst,
size_t  count 
)
inline

read bytes from the decode buffer

Load bytes from the decode buffer

Definition at line 618 of file encoding.h.

References bm::encoder::memcpy().

Referenced by bm::compressed_collection_deserializer< CBC >::deserialize(), and bm::sparse_vector_deserializer< SV >::load_remap().

◆ seek()

void bm::decoder_base::seek ( int  delta)
inline

◆ set_pos()

void bm::decoder_base::set_pos ( const unsigned char *  pos)
inline

Set current buffer pointer.

Definition at line 104 of file encoding.h.

Referenced by bm::deseriaizer_base< DEC, BLOCK_IDX >::try_skip().

◆ size()

size_t bm::decoder_base::size ( ) const
inline

Returns size of the current decoding stream.

Definition at line 92 of file encoding.h.

Field Documentation

◆ buf_

const unsigned char* bm::decoder_base::buf_
protected

◆ start_

const unsigned char* bm::decoder_base::start_
protected

Definition at line 107 of file encoding.h.


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