NCBI C++ ToolKit
Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
bm::deseriaizer_base< DEC, BLOCK_IDX > Class Template Reference

Search Toolkit Book for bm::deseriaizer_base

Base deserialization class. More...

#include <util/bitset/bmserial.h>

+ Inheritance diagram for bm::deseriaizer_base< DEC, BLOCK_IDX >:

Protected Types

typedef DEC decoder_type
 
typedef BLOCK_IDX block_idx_type
 
typedef bm::bit_in< DEC > bit_in_type
 

Protected Member Functions

 deseriaizer_base ()
 
void read_gap_block (decoder_type &decoder, unsigned block_type, bm::gap_word_t *dst_block, bm::gap_word_t &gap_head)
 Read GAP block from the stream. More...
 
unsigned read_id_list (decoder_type &decoder, unsigned block_type, bm::gap_word_t *dst_arr)
 Read list of bit ids. More...
 
void read_bic_arr (decoder_type &decoder, bm::word_t *blk, unsigned block_type) noexcept
 Read binary interpolated list into a bit-set. More...
 
unsigned read_bic_sb_arr (decoder_type &decoder, unsigned block_type, unsigned *dst_arr, unsigned *sb_idx)
 Read list of bit ids for super-blocks. More...
 
void read_bic_gap (decoder_type &decoder, bm::word_t *blk) noexcept
 Read binary interpolated gap blocks into a bitset. More...
 
void read_bic_arr_inv (decoder_type &decoder, bm::word_t *blk) noexcept
 Read inverted binary interpolated list into a bit-set. More...
 
void read_digest0_block (decoder_type &decoder, bm::word_t *blk) noexcept
 Read digest0-type bit-block. More...
 
block_idx_type try_skip (decoder_type &decoder, block_idx_type nb, block_idx_type expect_nb) noexcept
 Try to skip if skip bookmark is available within reach. More...
 

Static Protected Member Functions

static void read_0runs_block (decoder_type &decoder, bm::word_t *blk) noexcept
 read bit-block encoded as runs More...
 
static const char * err_msg () noexcept
 

Protected Attributes

bm::gap_word_tid_array_
 ptr to idx array for temp decode use More...
 
unsigned * sb_id_array_
 ptr to super-block idx array (temp) More...
 
block_idx_type bookmark_idx_
 last bookmark block index More...
 
unsigned skip_offset_
 bookmark to skip 256 encoded blocks More...
 
const unsigned char * skip_pos_
 decoder skip position More...
 

Detailed Description

template<typename DEC, typename BLOCK_IDX>
class bm::deseriaizer_base< DEC, BLOCK_IDX >

Base deserialization class.

Definition at line 493 of file bmserial.h.

Member Typedef Documentation

◆ bit_in_type

template<typename DEC , typename BLOCK_IDX >
typedef bm::bit_in<DEC> bm::deseriaizer_base< DEC, BLOCK_IDX >::bit_in_type
protected

Definition at line 498 of file bmserial.h.

◆ block_idx_type

template<typename DEC , typename BLOCK_IDX >
typedef BLOCK_IDX bm::deseriaizer_base< DEC, BLOCK_IDX >::block_idx_type
protected

Definition at line 497 of file bmserial.h.

◆ decoder_type

template<typename DEC , typename BLOCK_IDX >
typedef DEC bm::deseriaizer_base< DEC, BLOCK_IDX >::decoder_type
protected

Definition at line 496 of file bmserial.h.

Constructor & Destructor Documentation

◆ deseriaizer_base()

template<typename DEC , typename BLOCK_IDX >
bm::deseriaizer_base< DEC, BLOCK_IDX >::deseriaizer_base ( )
inlineprotected

Definition at line 501 of file bmserial.h.

Member Function Documentation

◆ err_msg()

template<typename DEC , typename BLOCK_IDX >
static const char* bm::deseriaizer_base< DEC, BLOCK_IDX >::err_msg ( )
inlinestaticprotectednoexcept

Definition at line 545 of file bmserial.h.

◆ read_0runs_block()

template<typename DEC , typename BLOCK_IDX >
void bm::deseriaizer_base< DEC, BLOCK_IDX >::read_0runs_block ( decoder_type decoder,
bm::word_t blk 
)
staticprotectednoexcept

read bit-block encoded as runs

Definition at line 3518 of file bmserial.h.

References bm::bit_block_set(), BM_ASSERT, and bm::set_block_size.

◆ read_bic_arr()

template<typename DEC , typename BLOCK_IDX >
void bm::deseriaizer_base< DEC, BLOCK_IDX >::read_bic_arr ( decoder_type decoder,
bm::word_t blk,
unsigned  block_type 
)
protectednoexcept

◆ read_bic_arr_inv()

template<typename DEC , typename BLOCK_IDX >
void bm::deseriaizer_base< DEC, BLOCK_IDX >::read_bic_arr_inv ( decoder_type decoder,
bm::word_t blk 
)
protectednoexcept

Read inverted binary interpolated list into a bit-set.

Definition at line 3445 of file bmserial.h.

References bm::bit_block_set(), bm::bit_invert(), and bm::set_block_arr_bienc.

◆ read_bic_gap()

template<typename DEC , typename BLOCK_IDX >
void bm::deseriaizer_base< DEC, BLOCK_IDX >::read_bic_gap ( decoder_type decoder,
bm::word_t blk 
)
protectednoexcept

Read binary interpolated gap blocks into a bitset.

Definition at line 3455 of file bmserial.h.

References bm::bit_in< TDecoder >::bic_decode_u16(), BM_ASSERT, BM_IS_GAP, bm::gap_add_to_bitset(), head, and IS_VALID_ADDR.

◆ read_bic_sb_arr()

template<typename DEC , typename BLOCK_IDX >
unsigned bm::deseriaizer_base< DEC, BLOCK_IDX >::read_bic_sb_arr ( decoder_type decoder,
unsigned  block_type,
unsigned *  dst_arr,
unsigned *  sb_idx 
)
protected

◆ read_digest0_block()

template<typename DEC , typename BLOCK_IDX >
void bm::deseriaizer_base< DEC, BLOCK_IDX >::read_digest0_block ( decoder_type decoder,
bm::word_t blk 
)
protectednoexcept

Read digest0-type bit-block.

Definition at line 3478 of file bmserial.h.

References bm::bmi_blsi_u64(), bm::bmi_bslr_u64(), IS_VALID_ADDR, bm::set_block_digest_wave_size, t, and bm::word_bitcount64().

◆ read_gap_block()

template<typename DEC , typename BLOCK_IDX >
void bm::deseriaizer_base< DEC, BLOCK_IDX >::read_gap_block ( decoder_type decoder,
unsigned  block_type,
bm::gap_word_t dst_block,
bm::gap_word_t gap_head 
)
protected

◆ read_id_list()

template<typename DEC , typename BLOCK_IDX >
unsigned bm::deseriaizer_base< DEC, BLOCK_IDX >::read_id_list ( decoder_type decoder,
unsigned  block_type,
bm::gap_word_t dst_arr 
)
protected

◆ try_skip()

template<typename DEC , typename BLOCK_IDX >
deseriaizer_base< DEC, BLOCK_IDX >::block_idx_type bm::deseriaizer_base< DEC, BLOCK_IDX >::try_skip ( decoder_type decoder,
block_idx_type  nb,
block_idx_type  expect_nb 
)
protectednoexcept

Member Data Documentation

◆ bookmark_idx_

template<typename DEC , typename BLOCK_IDX >
block_idx_type bm::deseriaizer_base< DEC, BLOCK_IDX >::bookmark_idx_
protected

last bookmark block index

Definition at line 558 of file bmserial.h.

◆ id_array_

template<typename DEC , typename BLOCK_IDX >
bm::gap_word_t* bm::deseriaizer_base< DEC, BLOCK_IDX >::id_array_
protected

ptr to idx array for temp decode use

Definition at line 555 of file bmserial.h.

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

◆ sb_id_array_

template<typename DEC , typename BLOCK_IDX >
unsigned* bm::deseriaizer_base< DEC, BLOCK_IDX >::sb_id_array_
protected

ptr to super-block idx array (temp)

Definition at line 556 of file bmserial.h.

◆ skip_offset_

template<typename DEC , typename BLOCK_IDX >
unsigned bm::deseriaizer_base< DEC, BLOCK_IDX >::skip_offset_
protected

bookmark to skip 256 encoded blocks

Definition at line 559 of file bmserial.h.

◆ skip_pos_

template<typename DEC , typename BLOCK_IDX >
const unsigned char* bm::deseriaizer_base< DEC, BLOCK_IDX >::skip_pos_
protected

decoder skip position

Definition at line 560 of file bmserial.h.


The documentation for this class was generated from the following file:
Modified on Mon Jul 22 05:02:25 2024 by modify_doxy.py rev. 669887