BitMagic-C++
bm::base_sparse_vector< Val, BV, MAX_SIZE > Class Template Reference

Base class for bit-transposed sparse vector construction. More...

#include <bmbmatrix.h>

Inheritance diagram for bm::base_sparse_vector< Val, BV, MAX_SIZE >:

Public Types

enum  bit_plains { sv_plains = (sizeof(Val) * 8 * MAX_SIZE + 1) , sv_value_plains = (sizeof(Val) * 8 * MAX_SIZE) }
enum  vector_capacity { max_vector_size = MAX_SIZE }
typedef Val value_type
typedef BV bvector_type
typedef BV::size_type size_type
typedef bvector_type * bvector_type_ptr
typedef const bvector_type * bvector_type_const_ptr
typedef const value_type & const_reference
typedef BV::allocator_type allocator_type
typedef bvector_type::allocation_policy allocation_policy_type
typedef bvector_type::enumerator bvector_enumerator_type
typedef allocator_type::allocator_pool_type allocator_pool_type
typedef bm::basic_bmatrix< BV > bmatrix_type

Public Member Functions

 base_sparse_vector ()
 base_sparse_vector (bm::null_support null_able, allocation_policy_type ap, size_type bv_max_size, const allocator_type &alloc)
 base_sparse_vector (const base_sparse_vector< Val, BV, MAX_SIZE > &bsv)
 base_sparse_vector (base_sparse_vector< Val, BV, MAX_SIZE > &&bsv) BMNOEXCEPT
void swap (base_sparse_vector< Val, BV, MAX_SIZE > &bsv) BMNOEXCEPT
size_type size () const BMNOEXCEPT
void resize (size_type new_size)
void clear_range (size_type left, size_type right, bool set_null)
void clear () BMNOEXCEPT
 resize to zero, free memory
bool empty () const BMNOEXCEPT
void optimize (bm::word_t *temp_block=0, typename bvector_type::optmode opt_mode=bvector_type::opt_compress, typename bvector_type::statistics *stat=0)
 run memory optimization for all bit-vector rows
void calc_stat (typename bvector_type::statistics *st) const BMNOEXCEPT
 Calculates memory statistics.
bool equal (const base_sparse_vector< Val, BV, MAX_SIZE > &sv, bm::null_support null_able=bm::use_null) const BMNOEXCEPT
 check if another sparse vector has the same content and size
Various traits
bool is_nullable () const BMNOEXCEPT
 check if container supports NULL(unassigned) values
const bvector_type * get_null_bvector () const BMNOEXCEPT
 Get bit-vector of assigned values or NULL (if not constructed that way).
bool is_null (size_type idx) const BMNOEXCEPT
 test if specified element is NULL

Protected Types

typedef bvector_type::block_idx_type block_idx_type

Protected Member Functions

void copy_from (const base_sparse_vector< Val, BV, MAX_SIZE > &bsv)
void clear_value_plains_from (unsigned plain_idx, size_type idx)
void insert_clear_value_plains_from (unsigned plain_idx, size_type idx)
void erase_column (size_type idx)
void insert_null (size_type idx, bool not_null)
void optimize_block (block_idx_type nb)
 optimize block in all matrix plains
void copy_range_plains (const base_sparse_vector< Val, BV, MAX_SIZE > &bsv, typename base_sparse_vector< Val, BV, MAX_SIZE >::size_type left, typename base_sparse_vector< Val, BV, MAX_SIZE >::size_type right, bm::null_support splice_null)
 Perform copy_range() on a set of plains.

Static Protected Member Functions

static unsigned value_bits () BMNOEXCEPT
 Number of total bit-plains in the value type.
static unsigned null_plain () BMNOEXCEPT
 plain index for the "NOT NULL" flags plain

Protected Attributes

bmatrix_type bmatr_
 bit-transposed matrix
size_type size_
 array size
unsigned effective_plains_

Access to internals

bvector_type_ptr get_plain (unsigned i)
 get access to bit-plain, function checks and creates a plain
bvector_type_const_ptr get_plain (unsigned i) const BMNOEXCEPT
 get read-only access to bit-plain
unsigned effective_plains () const BMNOEXCEPT
 Number of effective bit-plains in the value type.
bvector_type_ptr plain (unsigned i) BMNOEXCEPT
 get access to bit-plain as is (can return NULL)
bvector_type_const_ptr plain (unsigned i) const BMNOEXCEPT
bvector_type * get_null_bvect ()
void free_plain (unsigned i)
 free memory in bit-plain
bm::id64_t get_plains_mask (unsigned element_idx) const BMNOEXCEPT
const bmatrix_type & get_bmatrix () const BMNOEXCEPT
static unsigned plains () BMNOEXCEPT
 get total number of bit-plains in the vector
static unsigned stored_plains () BMNOEXCEPT
 Number of stored bit-plains (value plains + extra.

Detailed Description

template<typename Val, typename BV, unsigned MAX_SIZE>
class bm::base_sparse_vector< Val, BV, MAX_SIZE >

Base class for bit-transposed sparse vector construction.

Definition at line 253 of file bmbmatrix.h.

Member Typedef Documentation

◆ allocation_policy_type

template<typename Val, typename BV, unsigned MAX_SIZE>
typedef bvector_type::allocation_policy bm::base_sparse_vector< Val, BV, MAX_SIZE >::allocation_policy_type

Definition at line 274 of file bmbmatrix.h.

◆ allocator_pool_type

template<typename Val, typename BV, unsigned MAX_SIZE>
typedef allocator_type::allocator_pool_type bm::base_sparse_vector< Val, BV, MAX_SIZE >::allocator_pool_type

Definition at line 276 of file bmbmatrix.h.

◆ allocator_type

template<typename Val, typename BV, unsigned MAX_SIZE>
typedef BV::allocator_type bm::base_sparse_vector< Val, BV, MAX_SIZE >::allocator_type

Definition at line 273 of file bmbmatrix.h.

◆ block_idx_type

template<typename Val, typename BV, unsigned MAX_SIZE>
typedef bvector_type::block_idx_type bm::base_sparse_vector< Val, BV, MAX_SIZE >::block_idx_type
protected

Definition at line 468 of file bmbmatrix.h.

◆ bmatrix_type

template<typename Val, typename BV, unsigned MAX_SIZE>
typedef bm::basic_bmatrix<BV> bm::base_sparse_vector< Val, BV, MAX_SIZE >::bmatrix_type

Definition at line 277 of file bmbmatrix.h.

◆ bvector_enumerator_type

template<typename Val, typename BV, unsigned MAX_SIZE>
typedef bvector_type::enumerator bm::base_sparse_vector< Val, BV, MAX_SIZE >::bvector_enumerator_type

Definition at line 275 of file bmbmatrix.h.

◆ bvector_type

template<typename Val, typename BV, unsigned MAX_SIZE>
typedef BV bm::base_sparse_vector< Val, BV, MAX_SIZE >::bvector_type

Definition at line 268 of file bmbmatrix.h.

◆ bvector_type_const_ptr

template<typename Val, typename BV, unsigned MAX_SIZE>
typedef const bvector_type* bm::base_sparse_vector< Val, BV, MAX_SIZE >::bvector_type_const_ptr

Definition at line 271 of file bmbmatrix.h.

◆ bvector_type_ptr

template<typename Val, typename BV, unsigned MAX_SIZE>
typedef bvector_type* bm::base_sparse_vector< Val, BV, MAX_SIZE >::bvector_type_ptr

Definition at line 270 of file bmbmatrix.h.

◆ const_reference

template<typename Val, typename BV, unsigned MAX_SIZE>
typedef const value_type& bm::base_sparse_vector< Val, BV, MAX_SIZE >::const_reference

Definition at line 272 of file bmbmatrix.h.

◆ size_type

template<typename Val, typename BV, unsigned MAX_SIZE>
typedef BV::size_type bm::base_sparse_vector< Val, BV, MAX_SIZE >::size_type

Definition at line 269 of file bmbmatrix.h.

◆ value_type

template<typename Val, typename BV, unsigned MAX_SIZE>
typedef Val bm::base_sparse_vector< Val, BV, MAX_SIZE >::value_type

Definition at line 267 of file bmbmatrix.h.

Member Enumeration Documentation

◆ bit_plains

template<typename Val, typename BV, unsigned MAX_SIZE>
enum bm::base_sparse_vector::bit_plains
Enumerator
sv_plains 
sv_value_plains 

Definition at line 256 of file bmbmatrix.h.

◆ vector_capacity

template<typename Val, typename BV, unsigned MAX_SIZE>
enum bm::base_sparse_vector::vector_capacity
Enumerator
max_vector_size 

Definition at line 262 of file bmbmatrix.h.

Constructor & Destructor Documentation

◆ base_sparse_vector() [1/4]

template<class Val, class BV, unsigned MAX_SIZE>
bm::base_sparse_vector< Val, BV, MAX_SIZE >::base_sparse_vector ( )

Definition at line 1135 of file bmbmatrix.h.

References bmatr_, effective_plains_, bm::id_max, size_, and sv_plains.

Referenced by base_sparse_vector(), copy_from(), copy_range_plains(), equal(), and swap().

◆ base_sparse_vector() [2/4]

template<class Val, class BV, unsigned MAX_SIZE>
bm::base_sparse_vector< Val, BV, MAX_SIZE >::base_sparse_vector ( bm::null_support null_able,
allocation_policy_type ap,
size_type bv_max_size,
const allocator_type & alloc )

Definition at line 1145 of file bmbmatrix.h.

References bmatr_, effective_plains_, null_plain(), size_, sv_plains, and bm::use_null.

◆ base_sparse_vector() [3/4]

template<class Val, class BV, unsigned MAX_SIZE>
bm::base_sparse_vector< Val, BV, MAX_SIZE >::base_sparse_vector ( const base_sparse_vector< Val, BV, MAX_SIZE > & bsv)

Definition at line 1164 of file bmbmatrix.h.

References base_sparse_vector(), bmatr_, effective_plains_, and size_.

◆ base_sparse_vector() [4/4]

template<typename Val, typename BV, unsigned MAX_SIZE>
bm::base_sparse_vector< Val, BV, MAX_SIZE >::base_sparse_vector ( base_sparse_vector< Val, BV, MAX_SIZE > && bsv)
inline

move-ctor

Definition at line 291 of file bmbmatrix.h.

Member Function Documentation

◆ calc_stat()

template<class Val, class BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::calc_stat ( typename bvector_type::statistics * st) const

Calculates memory statistics.

Function fills statistics structure containing information about how this vector uses memory and estimation of max. amount of memory bvector needs to serialize itself.

Parameters
st- pointer on statistics structure to be filled in.
See also
statistics

Definition at line 1375 of file bmbmatrix.h.

References bm::bv_statistics::add(), BM_ASSERT, bmatr_, BMNOEXCEPT, and stored_plains().

◆ clear()

template<class Val, class BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::clear ( )

resize to zero, free memory

Definition at line 1223 of file bmbmatrix.h.

References bmatr_, BMNOEXCEPT, get_null_bvect(), plains(), size_, and value_bits().

Referenced by resize().

◆ clear_range()

template<typename Val, typename BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::clear_range ( size_type left,
size_type right,
bool set_null )

Definition at line 1239 of file bmbmatrix.h.

References bmatr_, clear_range(), get_null_bvect(), plains(), and value_bits().

Referenced by clear_range(), and resize().

◆ clear_value_plains_from()

template<class Val, class BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::clear_value_plains_from ( unsigned plain_idx,
size_type idx )
protected

clear column in all value plains

Parameters
plain_idx- row (plain index to start from)
idx- bit (column) to clear

Definition at line 1406 of file bmbmatrix.h.

References bmatr_, and sv_value_plains.

◆ copy_from()

template<class Val, class BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::copy_from ( const base_sparse_vector< Val, BV, MAX_SIZE > & bsv)
protected

◆ copy_range_plains()

template<class Val, class BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::copy_range_plains ( const base_sparse_vector< Val, BV, MAX_SIZE > & bsv,
typename base_sparse_vector< Val, BV, MAX_SIZE >::size_type left,
typename base_sparse_vector< Val, BV, MAX_SIZE >::size_type right,
bm::null_support splice_null )
protected

Perform copy_range() on a set of plains.

Definition at line 1504 of file bmbmatrix.h.

References base_sparse_vector(), bmatr_, get_null_bvect(), get_null_bvector(), get_plain(), plains(), bm::basic_bmatrix< BV >::row(), stored_plains(), and bm::use_null.

◆ effective_plains()

template<typename Val, typename BV, unsigned MAX_SIZE>
unsigned bm::base_sparse_vector< Val, BV, MAX_SIZE >::effective_plains ( ) const
inline

Number of effective bit-plains in the value type.

Definition at line 370 of file bmbmatrix.h.

◆ empty()

template<typename Val, typename BV, unsigned MAX_SIZE>
bool bm::base_sparse_vector< Val, BV, MAX_SIZE >::empty ( ) const
inline

return true if empty

Definition at line 312 of file bmbmatrix.h.

◆ equal()

template<class Val, class BV, unsigned MAX_SIZE>
bool bm::base_sparse_vector< Val, BV, MAX_SIZE >::equal ( const base_sparse_vector< Val, BV, MAX_SIZE > & sv,
bm::null_support null_able = bm::use_null ) const

check if another sparse vector has the same content and size

Parameters
sv- sparse vector for comparison
null_able- flag to consider NULL vector in comparison (default) or compare only value content plains
Returns
true, if it is the same

Definition at line 1447 of file bmbmatrix.h.

References base_sparse_vector(), BM_ASSERT, bmatr_, BMNOEXCEPT, get_null_bvector(), plains(), size_, and bm::use_null.

◆ erase_column()

template<class Val, class BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::erase_column ( size_type idx)
protected

erase bit (column) from all plains

Parameters
idx- bit (column) to erase

Definition at line 1434 of file bmbmatrix.h.

References bmatr_, and sv_value_plains.

◆ free_plain()

template<typename Val, typename BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::free_plain ( unsigned i)
inline

free memory in bit-plain

Definition at line 385 of file bmbmatrix.h.

◆ get_bmatrix()

template<typename Val, typename BV, unsigned MAX_SIZE>
const bmatrix_type & bm::base_sparse_vector< Val, BV, MAX_SIZE >::get_bmatrix ( ) const
inline

get read-only access to inetrnal bit-matrix

Definition at line 401 of file bmbmatrix.h.

◆ get_null_bvect()

template<typename Val, typename BV, unsigned MAX_SIZE>
bvector_type * bm::base_sparse_vector< Val, BV, MAX_SIZE >::get_null_bvect ( )
inline

Definition at line 380 of file bmbmatrix.h.

Referenced by clear(), clear_range(), copy_range_plains(), insert_null(), and optimize().

◆ get_null_bvector()

template<typename Val, typename BV, unsigned MAX_SIZE>
const bvector_type * bm::base_sparse_vector< Val, BV, MAX_SIZE >::get_null_bvector ( ) const
inline

Get bit-vector of assigned values or NULL (if not constructed that way).

Examples
xsample02.cpp, and xsample03.cpp.

Definition at line 329 of file bmbmatrix.h.

Referenced by copy_range_plains(), equal(), generate_random_subset(), is_null(), main(), and print_sorted().

◆ get_plain() [1/2]

template<class Val, class BV, unsigned MAX_SIZE>
base_sparse_vector< Val, BV, MAX_SIZE >::bvector_type_ptr bm::base_sparse_vector< Val, BV, MAX_SIZE >::get_plain ( unsigned i)

get access to bit-plain, function checks and creates a plain

Returns
bit-vector for the bit plain

Definition at line 1307 of file bmbmatrix.h.

References bmatr_, effective_plains_, and value_bits().

Referenced by copy_range_plains(), and get_plains_mask().

◆ get_plain() [2/2]

template<typename Val, typename BV, unsigned MAX_SIZE>
bvector_type_const_ptr bm::base_sparse_vector< Val, BV, MAX_SIZE >::get_plain ( unsigned i) const
inline

get read-only access to bit-plain

Returns
bit-vector for the bit plain or NULL

Definition at line 358 of file bmbmatrix.h.

◆ get_plains_mask()

template<class Val, class BV, unsigned MAX_SIZE>
bm::id64_t bm::base_sparse_vector< Val, BV, MAX_SIZE >::get_plains_mask ( unsigned element_idx) const

return mask of allocated bit-plains 1 in the mask - means bit-plain N is present returns 64-bit unsigned mask for sub 64-bit types (like int) unallocated mask bits will be zero extended

Returns
64-bit mask

Definition at line 1323 of file bmbmatrix.h.

References BM_ASSERT, BMNOEXCEPT, get_plain(), and plains().

◆ insert_clear_value_plains_from()

template<class Val, class BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::insert_clear_value_plains_from ( unsigned plain_idx,
size_type idx )
protected

insert false (clear) column in all value plains

Parameters
plain_idx- row (plain index to start from)
idx- bit (column) to clear insert

Definition at line 1420 of file bmbmatrix.h.

References bmatr_, and sv_value_plains.

◆ insert_null()

template<class Val, class BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::insert_null ( size_type idx,
bool not_null )
protected

insert (NOT) NULL value

Definition at line 1295 of file bmbmatrix.h.

References get_null_bvect().

◆ is_null()

template<class Val, class BV, unsigned MAX_SIZE>
bool bm::base_sparse_vector< Val, BV, MAX_SIZE >::is_null ( size_type idx) const

test if specified element is NULL

Parameters
idx- element index
Returns
true if it is NULL false if it was assigned or container is not configured to support assignment flags
Examples
svsample05.cpp.

Definition at line 1285 of file bmbmatrix.h.

References BMNOEXCEPT, and get_null_bvector().

Referenced by print_svector().

◆ is_nullable()

template<typename Val, typename BV, unsigned MAX_SIZE>
bool bm::base_sparse_vector< Val, BV, MAX_SIZE >::is_nullable ( ) const
inline

check if container supports NULL(unassigned) values

Definition at line 322 of file bmbmatrix.h.

Referenced by bm::sparse_vector< Val, BV >::join(), and bm::sparse_vector< Val, BV >::merge().

◆ null_plain()

template<typename Val, typename BV, unsigned MAX_SIZE>
unsigned bm::base_sparse_vector< Val, BV, MAX_SIZE >::null_plain ( )
inlinestaticprotected

◆ optimize()

template<class Val, class BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::optimize ( bm::word_t * temp_block = 0,
typename bvector_type::optmode opt_mode = bvector_type::opt_compress,
typename bvector_type::statistics * stat = 0 )

run memory optimization for all bit-vector rows

Parameters
temp_block- pre-allocated memory block to avoid unnecessary re-allocs
opt_mode- requested compression depth
stat- memory allocation statistics after optimization

Definition at line 1345 of file bmbmatrix.h.

References bm::bv_statistics::add(), bmatr_, get_null_bvect(), and stored_plains().

◆ optimize_block()

template<typename Val, typename BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::optimize_block ( block_idx_type nb)
inlineprotected

optimize block in all matrix plains

Definition at line 480 of file bmbmatrix.h.

◆ plain() [1/2]

template<typename Val, typename BV, unsigned MAX_SIZE>
bvector_type_ptr bm::base_sparse_vector< Val, BV, MAX_SIZE >::plain ( unsigned i)
inline

get access to bit-plain as is (can return NULL)

Definition at line 376 of file bmbmatrix.h.

Referenced by bm::str_sparse_vector< char, bm::bvector<>, 64 >::import_no_check().

◆ plain() [2/2]

template<typename Val, typename BV, unsigned MAX_SIZE>
bvector_type_const_ptr bm::base_sparse_vector< Val, BV, MAX_SIZE >::plain ( unsigned i) const
inline

Definition at line 377 of file bmbmatrix.h.

◆ plains()

template<typename Val, typename BV, unsigned MAX_SIZE>
unsigned bm::base_sparse_vector< Val, BV, MAX_SIZE >::plains ( )
inlinestatic

get total number of bit-plains in the vector

Definition at line 363 of file bmbmatrix.h.

Referenced by clear(), clear_range(), copy_from(), copy_range_plains(), equal(), get_plains_mask(), and bm::rsc_sparse_vector< unsigned, sparse_vector_u32 >::plains().

◆ resize()

template<class Val, class BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::resize ( size_type new_size)

Definition at line 1267 of file bmbmatrix.h.

References clear(), clear_range(), size(), and size_.

Referenced by copy_from().

◆ size()

template<typename Val, typename BV, unsigned MAX_SIZE>
size_type bm::base_sparse_vector< Val, BV, MAX_SIZE >::size ( ) const
inline

Definition at line 302 of file bmbmatrix.h.

Referenced by copy_from(), bm::base_sparse_vector< Val, BV, 1 >::empty(), and resize().

◆ stored_plains()

template<typename Val, typename BV, unsigned MAX_SIZE>
unsigned bm::base_sparse_vector< Val, BV, MAX_SIZE >::stored_plains ( )
inlinestatic

Number of stored bit-plains (value plains + extra.

Definition at line 366 of file bmbmatrix.h.

Referenced by calc_stat(), copy_from(), copy_range_plains(), optimize(), and bm::rsc_sparse_vector< unsigned, sparse_vector_u32 >::stored_plains().

◆ swap()

template<class Val, class BV, unsigned MAX_SIZE>
void bm::base_sparse_vector< Val, BV, MAX_SIZE >::swap ( base_sparse_vector< Val, BV, MAX_SIZE > & bsv)

Definition at line 1208 of file bmbmatrix.h.

References base_sparse_vector(), bmatr_, BMNOEXCEPT, effective_plains_, size_, and bm::xor_swap().

◆ value_bits()

template<typename Val, typename BV, unsigned MAX_SIZE>
unsigned bm::base_sparse_vector< Val, BV, MAX_SIZE >::value_bits ( )
inlinestaticprotected

Field Documentation

◆ bmatr_

◆ effective_plains_

template<typename Val, typename BV, unsigned MAX_SIZE>
unsigned bm::base_sparse_vector< Val, BV, MAX_SIZE >::effective_plains_
protected

◆ size_


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