bm::bvector< Alloc, MS > Class Template Reference
[The Main bvector<> Group]

Search Toolkit Book for bm::bvector

#include <bm.h>

Collaboration diagram for bm::bvector< Alloc, MS >:

[legend]List of all members.

---

Detailed Description

template<class Alloc, class MS>
class bm::bvector< Alloc, MS >

bitvector with runtime compression of bits.

Definition at line 116 of file bm.h.

Public Types
typedef Alloc	allocator_type
typedef blocks_manager< Alloc, MS >	blocks_manager_type
typedef bm::id_t	size_type
	Type used to count bits in the bit vector.
typedef bool	const_reference
enum	optmode { opt_free_0 = 1, opt_free_01 = 2, opt_compress = 3 }
	Optimization mode Every next level means additional checks (better compression vs time). More...
Public Member Functions
	bvector (strategy strat=BM_BIT, const gap_word_t *glevel_len=bm::gap_len_table< true >::_len, size_type bv_size=bm::id_max, const Alloc &alloc=Alloc())
	Constructs bvector class.
	bvector (size_type bv_size, strategy strat=BM_BIT, const gap_word_t *glevel_len=bm::gap_len_table< true >::_len, const Alloc &alloc=Alloc())
	Constructs bvector class.
	bvector (const bvector< Alloc, MS > &bvect)
bvector &	operator= (const bvector< Alloc, MS > &bvect)
reference	operator[] (bm::id_t n)
bool	operator[] (bm::id_t n) const
void	operator &= (const bvector< Alloc, MS > &bvect)
void	operator^= (const bvector< Alloc, MS > &bvect)
void	operator|= (const bvector< Alloc, MS > &bvect)
void	operator-= (const bvector< Alloc, MS > &bvect)
bool	operator< (const bvector< Alloc, MS > &bvect) const
bool	operator<= (const bvector< Alloc, MS > &bvect) const
bool	operator> (const bvector< Alloc, MS > &bvect) const
bool	operator>= (const bvector< Alloc, MS > &bvect) const
bool	operator== (const bvector< Alloc, MS > &bvect) const
bool	operator!= (const bvector< Alloc, MS > &bvect) const
bvector< Alloc, MS >	operator~ () const
Alloc	get_allocator () const
bool	set_bit (bm::id_t n, bool val=true)
	Sets bit n.
bool	set_bit_and (bm::id_t n, bool val=true)
	Sets bit n using bit AND with the provided value.
bool	set_bit_conditional (bm::id_t n, bool val, bool condition)
	Sets bit n only if current value is equal to the condition.
bvector< Alloc, MS > &	set (bm::id_t n, bool val=true)
	Sets bit n if val is true, clears bit n if val is false.
bvector< Alloc, MS > &	set ()
	Sets every bit in this bitset to 1.
bvector< Alloc, MS > &	set_range (bm::id_t left, bm::id_t right, bool value=true)
	Sets all bits in the specified closed interval [left,right] Interval must be inside the bvector's size. This method DOES NOT resize vector.
insert_iterator	inserter ()
void	clear_bit (bm::id_t n)
	Clears bit n.
void	clear (bool free_mem=false)
	Clears every bit in the bitvector.
bvector< Alloc, MS > &	reset ()
	Clears every bit in the bitvector.
bm::id_t	count () const
	Returns count of bits which are 1.
size_type	capacity () const
	Returns bvector's capacity (number of bits it can store).
size_type	size () const
	return current size of the vector (bits)
void	resize (size_type new_size)
	Change size of the bvector.
unsigned	count_blocks (unsigned *arr) const
	Computes bitcount values for all bvector blocks.
bm::id_t	count_range (bm::id_t left, bm::id_t right, unsigned *block_count_arr=0) const
	Returns count of 1 bits in the given diapason.
bm::id_t	recalc_count ()
void	forget_count ()
bvector< Alloc, MS > &	invert ()
	Inverts all bits.
bool	get_bit (bm::id_t n) const
	returns true if bit n is set and false is bit n is 0.
bool	test (bm::id_t n) const
	returns true if bit n is set and false is bit n is 0.
bool	any () const
	Returns true if any bits in this bitset are set, and otherwise returns false.
bool	none () const
	Returns true if no bits are set, otherwise returns false.
bvector< Alloc, MS > &	flip (bm::id_t n)
	Flips bit n.
bvector< Alloc, MS > &	flip ()
	Flips all bits.
void	swap (bvector< Alloc, MS > &bv)
	Exchanges content of bv and this bitvector.
bm::id_t	get_first () const
	Gets number of first bit which is ON.
bm::id_t	get_next (bm::id_t prev) const
	Finds the number of the next bit ON.
bm::id_t	extract_next (bm::id_t prev)
	Finds the number of the next bit ON and sets it to 0.
void	calc_stat (struct bm::bvector< Alloc, MS >::statistics *st) const
	Calculates bitvector statistics.
bm::bvector< Alloc, MS > &	bit_or (const bm::bvector< Alloc, MS > &vect)
	Logical OR operation.
bm::bvector< Alloc, MS > &	bit_and (const bm::bvector< Alloc, MS > &vect)
	Logical AND operation.
bm::bvector< Alloc, MS > &	bit_xor (const bm::bvector< Alloc, MS > &vect)
	Logical XOR operation.
bm::bvector< Alloc, MS > &	bit_sub (const bm::bvector< Alloc, MS > &vect)
	Logical SUB operation.
void	set_new_blocks_strat (strategy strat)
	Sets new blocks allocation strategy.
strategy	get_new_blocks_strat () const
	Returns blocks allocation strategy.
void	optimize (bm::word_t *temp_block=0, optmode opt_mode=opt_compress, statistics *stat=0)
	Optimize memory bitvector's memory allocation.
void	optimize_gap_size ()
	Optimize sizes of GAP blocks.
void	set_gap_levels (const gap_word_t *glevel_len)
	Sets new GAP lengths table. All GAP blocks will be reallocated to match the new scheme.
int	compare (const bvector< Alloc, MS > &bvect) const
	Lexicographical comparison with a bitvector.
bm::word_t *	allocate_tempblock () const
	Allocates temporary block of memory.
void	free_tempblock (bm::word_t *block) const
	Frees temporary block of memory.
enumerator	first () const
	Returns enumerator pointing on the first non-zero bit.
enumerator	end () const
	Returns enumerator pointing on the next bit after the last.
const bm::word_t *	get_block (unsigned nb) const
void	combine_operation (const bm::bvector< Alloc, MS > &bvect, bm::operation opcode)
void	combine_operation_with_block (unsigned nb, const bm::word_t *arg_blk, int arg_gap, bm::operation opcode)
const blocks_manager_type &	get_blocks_manager () const
blocks_manager_type &	get_blocks_manager ()
Private Member Functions
bm::id_t	check_or_next (bm::id_t prev) const
bm::id_t	check_or_next_extract (bm::id_t prev)
	check if specified bit is 1, and set it to 0 if specified bit is 0, scan for the next 1 and returns it if no 1 found returns 0
bool	set_bit_no_check (bm::id_t n, bool val)
	Set specified bit without checking preconditions (size, etc).
bool	and_bit_no_check (bm::id_t n, bool val)
	AND specified bit without checking preconditions (size, etc).
bool	set_bit_conditional_impl (bm::id_t n, bool val, bool condition)
void	combine_operation_with_block (unsigned nb, unsigned gap, bm::word_t *blk, const bm::word_t *arg_blk, int arg_gap, bm::operation opcode)
void	combine_count_operation_with_block (unsigned nb, const bm::word_t *arg_blk, int arg_gap, bm::operation opcode)
void	extend_gap_block (unsigned nb, gap_word_t *blk)
	Extends GAP block to the next level or converts it to bit block.
void	set_range_no_check (bm::id_t left, bm::id_t right, bool value)
	Set range without validity checking.
Private Attributes
blocks_manager_type	blockman_
	bitblocks manager
strategy	new_blocks_strat_
	block allocation strategy
size_type	size_
	size in bits
Friends
class	iterator_base
class	enumerator
Classes
class	counted_enumerator
	Constant input iterator designed to enumerate "ON" bits counted_enumerator keeps bitcount, ie number of ON bits starting from the position 0 in the bit string up to the currently enumerated bit. More...
class	enumerator
	Constant input iterator designed to enumerate "ON" bits. More...
class	insert_iterator
	Output iterator iterator designed to set "ON" bits based on input sequence of integers (bit indeces). More...
class	iterator_base
	Base class for all iterators. More...
class	reference
	Class reference implements an object for bit assignment. More...
struct	statistics
	Statistical information about bitset's memory allocation details. More...

---

Member Typedef Documentation

template<class Alloc, class MS> typedef Alloc bm::bvector< Alloc, MS >::allocator_type

Definition at line 120 of file bm.h.

template<class Alloc, class MS> typedef blocks_manager<Alloc, MS> bm::bvector< Alloc, MS >::blocks_manager_type

Definition at line 121 of file bm.h.

template<class Alloc, class MS> typedef bool bm::bvector< Alloc, MS >::const_reference

Definition at line 221 of file bm.h.

template<class Alloc, class MS> typedef bm::id_t bm::bvector< Alloc, MS >::size_type

Type used to count bits in the bit vector. Definition at line 123 of file bm.h.

---

Member Enumeration Documentation

template<class Alloc, class MS> enum bm::bvector::optmode

Optimization mode Every next level means additional checks (better compression vs time). See also: optimize Enumerator: opt_free_0  Free unused 0 blocks. opt_free_01  Free unused 0 and 1 blocks. opt_compress  compress blocks when possible Definition at line 1344 of file bm.h.

---

Constructor & Destructor Documentation

template<class Alloc, class MS> bm::bvector< Alloc, MS >::bvector (  strategy  strat = BM_BIT, const gap_word_t *  glevel_len = bm::gap_len_table<true>::_len, size_type  bv_size = bm::id_max, const Alloc &  alloc = Alloc() )  [inline]

Constructs bvector class. Parameters: strat  - operation mode strategy, BM_BIT - default strategy, bvector use plain bitset blocks, (performance oriented strategy). BM_GAP - memory effitent strategy, bvector allocates blocks as array of intervals(gaps) and convert blocks into plain bitsets only when enthropy grows. glevel_len  pointer on C-style array keeping GAP block sizes. (Put bm::gap_len_table_min<true>::_len for GAP memory saving mode) bv_size  bvector size (number of bits addressable by bvector), bm::id_max means "no limits" (recommended). bit vector allocates this space dynamically on demand. See also: bm::gap_len_table bm::gap_len_table_min set_new_blocks_strat Definition at line 832 of file bm.h.

template<class Alloc, class MS> bm::bvector< Alloc, MS >::bvector (  size_type  bv_size, strategy  strat = BM_BIT, const gap_word_t *  glevel_len = bm::gap_len_table<true>::_len, const Alloc &  alloc = Alloc() )  [inline]

Constructs bvector class. Definition at line 844 of file bm.h.

template<class Alloc, class MS> bm::bvector< Alloc, MS >::bvector (  const bvector< Alloc, MS > &  bvect  )  [inline]

Definition at line 854 of file bm.h.

---

Member Function Documentation

template<class Alloc, class MS> bm::word_t* bm::bvector< Alloc, MS >::allocate_tempblock (   )  const [inline]

Allocates temporary block of memory. Temp block can be passed to bvector functions requiring some temp memory for their operation. (like serialize) Note: method is marked const, but it's not quite true, since it can in some cases modify the state of the block allocator (if it has a state). (Can be important in MT programs). See also: free_tempblock Definition at line 1405 of file bm.h. References bm::blocks_manager< Alloc, MS >::get_allocator(). Referenced by CObjectOStreamAsnBinary::WriteBitString().

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::and_bit_no_check (  bm::id_t  n, bool  val )  [private]

AND specified bit without checking preconditions (size, etc). Definition at line 2282 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, BM_ASSERT, BMCOUNT_ADJ, BMCOUNT_DEC, BMCOUNT_INC, BMGAP_PTR, bm::blocks_manager< Alloc, MS >::check_allocate_block(), bm::bvector< Alloc, MS >::extend_gap_block(), bm::gap_limit(), bm::gap_set_value(), bm::gap_test(), bm::bvector< Alloc, MS >::get_new_blocks_strat(), bm::blocks_manager< Alloc, MS >::glen(), mask, bm::set_block_mask, bm::set_block_shift, bm::set_word_mask, and bm::set_word_shift.

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::any (   )  const [inline]

Returns true if any bits in this bitset are set, and otherwise returns false. Returns: true if any bit is set Definition at line 1167 of file bm.h. References bm::for_each_nzblock_if(). Referenced by CJobStatusTracker::AnyPending(), SAffinityInfo::BlacklistJob(), CheckVectors(), CQueue::DeleteBatch(), CLDS_Object::DeleteUpdateCascadeFiles(), CLDS_Query::CSequenceFinder::Find(), CLDS_Query::CSequenceFinder::FindInCandidates(), CQueue::FindPendingJob(), CWorkerNodeAffinityGuard::GetJobWithAffinities(), CJobStatusTracker::GetPendingJob(), CJobStatusTracker::GetPendingJobFromSet(), CWorkerNodeAffinityGuard::HasCandidates(), ResizeTest(), CQueue::x_ChangeGroupStatus(), and CNetSchedule_AccessList::x_IsRestrictionSet().

template<class Alloc, class MS> bm::bvector<Alloc, MS>& bm::bvector< Alloc, MS >::bit_and (  const bm::bvector< Alloc, MS > &  vect  )  [inline]

Logical AND operation. Parameters: vect  - Argument vector. Definition at line 1287 of file bm.h. References bm::BM_AND, and BMCOUNT_VALID. Referenced by AndOperationsTest(), MutationOperationsTest(), and bm::operator &().

template<class Alloc, class MS> bm::bvector<Alloc, MS>& bm::bvector< Alloc, MS >::bit_or (  const bm::bvector< Alloc, MS > &  vect  )  [inline]

Logical OR operation. Parameters: vect  - Argument vector. Definition at line 1276 of file bm.h. References bm::BM_OR, and BMCOUNT_VALID. Referenced by bm::operator|(), and OrOperationsTest().

template<class Alloc, class MS> bm::bvector<Alloc, MS>& bm::bvector< Alloc, MS >::bit_sub (  const bm::bvector< Alloc, MS > &  vect  )  [inline]

Logical SUB operation. Parameters: vect  - Argument vector. Definition at line 1309 of file bm.h. References bm::BM_SUB, and BMCOUNT_VALID. Referenced by bm::operator-(), and SubOperationsTest().

template<class Alloc, class MS> bm::bvector<Alloc, MS>& bm::bvector< Alloc, MS >::bit_xor (  const bm::bvector< Alloc, MS > &  vect  )  [inline]

Logical XOR operation. Parameters: vect  - Argument vector. Definition at line 1298 of file bm.h. References bm::BM_XOR, and BMCOUNT_VALID. Referenced by bm::operator^(), and XorOperationsTest().

template<typename Alloc, typename MS> void bm::bvector< Alloc, MS >::calc_stat (  struct bm::bvector< Alloc, MS >::statistics *  st  )  const

Calculates bitvector statistics. Parameters: st  - pointer on statistics structure to be filled in. Function fills statistics structure containing information about how this vector uses memory and estimation of max. amount of memory bvector needs to serialize itself. See also: statistics Definition at line 2042 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, BM_IS_GAP, BMGAP_PTR, bm::blocks_manager< Alloc, MS >::effective_top_block_size(), bm::gap_capacity(), bm::gap_length(), bm::gap_levels, bm::blocks_manager< Alloc, MS >::get_topblock(), bm::blocks_manager< Alloc, MS >::glen(), and IS_VALID_ADDR. Referenced by bm::bvector< Alloc, MS >::optimize_gap_size(), ResizeTest(), SerializationOperation(), SerializationTest(), SetTest(), CJobStatusTracker::StatusStatistics(), and CObjectOStreamAsnBinary::WriteBitString().

template<class Alloc, class MS> size_type bm::bvector< Alloc, MS >::capacity (   )  const [inline]

Returns bvector's capacity (number of bits it can store). Definition at line 1074 of file bm.h.

template<class Alloc, class MS> bm::id_t bm::bvector< Alloc, MS >::check_or_next (  bm::id_t  prev  )  const [private]

Definition at line 2353 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, bm::blocks_manager< Alloc, MS >::is_subblock_null(), bm::set_blkblk_mask, bm::set_block_shift, and bm::set_total_blocks.

template<class Alloc, class MS> bm::id_t bm::bvector< Alloc, MS >::check_or_next_extract (  bm::id_t  prev  )  [private]

check if specified bit is 1, and set it to 0 if specified bit is 0, scan for the next 1 and returns it if no 1 found returns 0 Definition at line 2416 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, bm::blocks_manager< Alloc, MS >::is_subblock_null(), bm::set_blkblk_mask, bm::set_block_shift, and bm::set_total_blocks.

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::clear (  bool  free_mem = false  )  [inline]

Clears every bit in the bitvector. Parameters: free_mem  if "true" (default) bvector frees the memory, otherwise sets blocks to 0. Definition at line 1048 of file bm.h. References BMCOUNT_SET. Referenced by CWorkerNodeAffinityGuard::CleanCandidates(), CNetSchedule_JSGroupGuard::Commit(), ComparisonTest(), CLDS_Query::CSequenceFinder::Find(), CBDB_Cache::GetNextBlobId(), CObjectIStreamXml::ReadBitString(), CObjectIStreamAsnBinary::ReadBitString(), CObjectIStreamAsn::ReadBitString(), SerializationOperation2Test(), CNetSchedule_AccessList::SetHosts(), and SetTest().

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::clear_bit (  bm::id_t  n  )  [inline]

Clears bit n. Parameters: n  - bit's index to be cleaned. Definition at line 1036 of file bm.h. Referenced by EnumeratorTest().

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::combine_count_operation_with_block (  unsigned  nb, const bm::word_t *  arg_blk, int  arg_gap, bm::operation  opcode )  [inline, private]

Definition at line 1494 of file bm.h. References BM_IS_GAP, and bm::combine_count_operation_with_block().

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::combine_operation (  const bm::bvector< Alloc, MS > &  bvect, bm::operation  opcode )

Definition at line 2509 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, bm::blocks_manager< Alloc, MS >::blocks_root(), bm::BM_AND, BM_ASSERT, bm::blocks_manager< Alloc, MS >::effective_top_block_size(), bm::blocks_manager< Alloc, MS >::reserve_top_blocks(), bm::bvector< Alloc, MS >::set_range(), bm::bvector< Alloc, MS >::size_, and bm::blocks_manager< Alloc, MS >::top_block_size().

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::combine_operation_with_block (  unsigned  nb, const bm::word_t *  arg_blk, int  arg_gap, bm::operation  opcode )  [inline]

Definition at line 1484 of file bm.h. References BM_IS_GAP.

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::combine_operation_with_block (  unsigned  nb, unsigned  gap, bm::word_t *  blk, const bm::word_t *  arg_blk, int  arg_gap, bm::operation  opcode )  [private]

Definition at line 2635 of file bm.h. References bm::blocks_manager< Alloc, MS >::allocate_gap_block(), bm::bvector< Alloc, MS >::blockman_, bm::BM_AND, BM_ASSERT, bm::BM_GAP, bm::BM_OR, bm::BM_SUB, bm::BM_XOR, BMGAP_PTR, BMSET_PTRGAP, bm::blocks_manager< Alloc, MS >::check_allocate_block(), bm::blocks_manager< Alloc, MS >::convert_gap2bitset(), bm::blocks_manager< Alloc, MS >::extend_gap_block(), bm::gap_bit_count(), bm::gap_calc_level(), bm::gap_convert_to_arr(), bm::gap_equiv_len, bm::gap_is_all_zero(), bm::gap_level(), bm::gap_limit(), bm::gap_max_bits, bm::gap_set_value(), bm::blocks_manager< Alloc, MS >::get_allocator(), bm::blocks_manager< Alloc, MS >::glen(), bm::or_bit_block(), bm::blocks_manager< Alloc, MS >::set_block_ptr(), bm::set_gap_level(), bm::test_bit(), and bm::blocks_manager< Alloc, MS >::zero_block(). Referenced by bm::bvector< Alloc, MS >::set_range_no_check().

template<typename Alloc, typename MS> int bm::bvector< Alloc, MS >::compare (  const bvector< Alloc, MS > &  bvect  )  const

Lexicographical comparison with a bitvector. Function compares current bitvector with the provided argument bit by bit and returns -1 if our bitvector less than the argument, 1 - greater, 0 - equal. Definition at line 1912 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, BM_IS_GAP, bm::blocks_manager< Alloc, MS >::effective_top_block_size(), and bm::blocks_manager< Alloc, MS >::get_topblock(). Referenced by ComparisonTest(), ResizeTest(), and SerializationOperation().

template<typename Alloc, typename MS> bm::id_t bm::bvector< Alloc, MS >::count (   )  const

Returns count of bits which are 1. Returns: Total number of bits ON. Definition at line 1641 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, BMCOUNT_SET, bm::blocks_manager< Alloc, MS >::effective_top_block_size(), bm::for_each_nzblock(), and bm::blocks_manager< Alloc, MS >::get_rootblock(). Referenced by AndOperationsTest(), BitCountChange(), CheckVectors(), CWorkerNodeAffinityGuard::CleanCandidates(), CQueue::ClearAffinityIdx(), bm::bvector< Alloc, MS >::count_range(), CQueueDataBase::CountActiveJobs(), ExportTest(), CWorkerNodeAffinityGuard::GetJobWithAffinities(), main(), OrOperationsTest(), CBDB_Cache::Purge(), CSubFileByteSourceReader::Read(), ResizeTest(), SerializationOperation(), SerializationOperation2Test(), SetTest(), SubOperationsTest(), and XorOperationsTest().

template<class Alloc, class MS> unsigned bm::bvector< Alloc, MS >::count_blocks (  unsigned *  arr  )  const [inline]

Computes bitcount values for all bvector blocks. Parameters: arr  - pointer on array of block bit counts Returns: Index of the last block counted. This number +1 gives you number of arr elements initialized during the function call. Definition at line 1099 of file bm.h. References bm::for_each_nzblock(). Referenced by main().

template<typename Alloc, typename MS> bm::id_t bm::bvector< Alloc, MS >::count_range (  bm::id_t  left, bm::id_t  right, unsigned *  block_count_arr = 0 )  const

Returns count of 1 bits in the given diapason. Parameters: left  - index of first bit start counting from right  - index of last bit block_count_arr  - optional parameter (bitcount by bvector blocks) calculated by count_blocks method. Used to improve performance of wide range searches Returns: Total number of bits ON. Definition at line 1681 of file bm.h. References bm::bit_block_calc_count_range(), bm::bits_in_block, bm::bvector< Alloc, MS >::blockman_, BM_ASSERT, BM_IS_GAP, BMGAP_PTR, bm::bvector< Alloc, MS >::count(), bm::gap_bit_count_range(), bm::blocks_manager< Alloc, MS >::get_block(), bm::set_block_mask, and bm::set_block_shift. Referenced by main().

template<class Alloc, class MS> bvector::enumerator bm::bvector< Alloc, MS >::end (  void   )  const [inline]

Returns enumerator pointing on the next bit after the last. Definition at line 1440 of file bm.h. Referenced by EnumeratorTest(), CLDS_Query::CSequenceFinder::FindInCandidates(), CQueue::FlushTags(), and CObjectOStreamAsn::WriteBitString().

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::extend_gap_block (  unsigned  nb, gap_word_t *  blk )  [inline, private]

Extends GAP block to the next level or converts it to bit block. Parameters: nb  - Block's linear index. blk  - Blocks's pointer Definition at line 1510 of file bm.h. Referenced by bm::bvector< Alloc, MS >::and_bit_no_check(), bm::bvector< Alloc, MS >::set_bit_conditional_impl(), and bm::bvector< Alloc, MS >::set_bit_no_check().

template<class Alloc, class MS> bm::id_t bm::bvector< Alloc, MS >::extract_next (  bm::id_t  prev  )  [inline]

Finds the number of the next bit ON and sets it to 0. Parameters: prev  - Index of the previously found bit. Returns: Index of the next bit which is ON or 0 if not found. See also: get_first, get_next, Definition at line 1253 of file bm.h. References bm::id_max. Referenced by CQueue::DeleteBatch().

template<class Alloc, class MS> enumerator bm::bvector< Alloc, MS >::first (   )  const [inline]

Returns enumerator pointing on the first non-zero bit. Definition at line 1430 of file bm.h. Referenced by CQueue::CheckExecutionTimeout(), CheckVectors(), CLDS_File::Delete(), EnumeratorTest(), CQueue::ExecProject(), CLDS_Query::CSequenceFinder::FindInCandidates(), CQueue::GetJobsWithAffinities(), CJobStatusTracker::GetPendingJob(), CJobStatusTracker::GetPendingJobFromSet(), main(), NS_EncodeBitVector(), OrOperationsTest(), CNetSchedule_AccessList::Print(), CNetSchedule_AccessList::PrintHosts(), CQueue::PrintJobDbStat(), CQueue::PrintQueue(), CJobStatusTracker::PrintStatusMatrix(), CQueue::ReadJobs(), ResizeTest(), CJobStatusTracker::SwitchJobs(), and CQueue::x_ChangeGroupStatus().

template<class Alloc, class MS> bvector<Alloc, MS>& bm::bvector< Alloc, MS >::flip (   )  [inline]

Flips all bits. Returns: *this Definition at line 1205 of file bm.h. References invert.

template<class Alloc, class MS> bvector<Alloc, MS>& bm::bvector< Alloc, MS >::flip (  bm::id_t  n  )  [inline]

Flips bit n. Returns: *this Definition at line 1195 of file bm.h. Referenced by SyntaxTest().

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::forget_count (   )  [inline]

Disables count cache. Next call to count() or recalc_count() restores count caching. Note: Works only if BMCOUNTOPT enabled(defined). Othewise does nothing. Definition at line 1135 of file bm.h. References BMCOUNT_VALID.

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::free_tempblock (  bm::word_t *  block  )  const [inline]

Frees temporary block of memory. Note: method is marked const, but it's not quite true, since it can in some cases modify the state of the block allocator (if it has a state). (Can be important in MT programs). See also: allocate_tempblock Definition at line 1420 of file bm.h. References bm::blocks_manager< Alloc, MS >::get_allocator().

template<class Alloc, class MS> Alloc bm::bvector< Alloc, MS >::get_allocator (   )  const [inline]

Definition at line 938 of file bm.h. Referenced by SyntaxTest().

template<typename Alloc, typename MS> bool bm::bvector< Alloc, MS >::get_bit (  bm::id_t  n  )  const

returns true if bit n is set and false is bit n is 0. Parameters: n  - Index of the bit to check. Returns: Bit value (1 or 0) Definition at line 1799 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, BM_ASSERT, BM_IS_GAP, BMGAP_PTR, bm::gap_test(), bm::blocks_manager< Alloc, MS >::get_block(), bm::set_block_mask, bm::set_block_shift, bm::set_word_mask, bm::set_word_shift, and bm::bvector< Alloc, MS >::size_. Referenced by CheckVectors(), and DetailedCheckVectors().

template<class Alloc, class MS> const bm::word_t* bm::bvector< Alloc, MS >::get_block (  unsigned  nb  )  const [inline]

Definition at line 1447 of file bm.h.

template<class Alloc, class MS> blocks_manager_type& bm::bvector< Alloc, MS >::get_blocks_manager (   )  [inline]

Definition at line 1528 of file bm.h.

template<class Alloc, class MS> const blocks_manager_type& bm::bvector< Alloc, MS >::get_blocks_manager (   )  const [inline]

Definition at line 1523 of file bm.h.

template<class Alloc, class MS> bm::id_t bm::bvector< Alloc, MS >::get_first (   )  const [inline]

Gets number of first bit which is ON. Returns: Index of the first 1 bit. See also: get_next, extract_next Definition at line 1232 of file bm.h. Referenced by CheckVectors(), bm::bvector_mini< A >::compare(), EnumeratorTest(), CJobStatusTracker::GetFirst(), GetNextTest(), and ResizeTest().

template<class Alloc, class MS> strategy bm::bvector< Alloc, MS >::get_new_blocks_strat (   )  const [inline]

Returns blocks allocation strategy. Returns: - Strategy code 0 - bitblocks allocation only. 1 - Blocks mutation mode (adaptive algorithm) See also: set_new_blocks_strat Definition at line 1333 of file bm.h. Referenced by bm::bvector< Alloc, MS >::and_bit_no_check(), bm::bvector< Alloc, MS >::set_bit_conditional_impl(), and bm::bvector< Alloc, MS >::set_bit_no_check().

template<class Alloc, class MS> bm::id_t bm::bvector< Alloc, MS >::get_next (  bm::id_t  prev  )  const [inline]

Finds the number of the next bit ON. Parameters: prev  - Index of the previously found bit. Returns: Index of the next bit which is ON or 0 if not found. See also: get_first, extract_next Definition at line 1241 of file bm.h. References bm::id_max. Referenced by CheckVectors(), EnumeratorTest(), CJobStatusTracker::GetNext(), GetNextTest(), and ResizeTest().

template<class Alloc, class MS> insert_iterator bm::bvector< Alloc, MS >::inserter (   )  [inline]

Function erturns insert iterator for this bitvector Definition at line 1026 of file bm.h.

template<typename Alloc, typename MS> bvector< Alloc, MS > & bm::bvector< Alloc, MS >::invert (   )

Inverts all bits. Definition at line 1775 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, BMCOUNT_VALID, bm::for_each_block(), bm::blocks_manager< Alloc, MS >::get_rootblock(), bm::id_max, bm::bvector< Alloc, MS >::set_bit_no_check(), bm::bvector< Alloc, MS >::set_range_no_check(), bm::bvector< Alloc, MS >::size_, and bm::blocks_manager< Alloc, MS >::top_block_size(). Referenced by ResizeTest(), and SetTest().

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::none (   )  const [inline]

Returns true if no bits are set, otherwise returns false. Definition at line 1186 of file bm.h. Referenced by CLDS_Object::DeleteCascadeFiles(), and CLDS_Object::UpdateCascadeFiles().

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::operator &= (  const bvector< Alloc, MS > &  bvect  )  [inline]

Definition at line 883 of file bm.h.

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::operator!= (  const bvector< Alloc, MS > &  bvect  )  const [inline]

Definition at line 928 of file bm.h.

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::operator-= (  const bvector< Alloc, MS > &  bvect  )  [inline]

Definition at line 898 of file bm.h.

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::operator< (  const bvector< Alloc, MS > &  bvect  )  const [inline]

Definition at line 903 of file bm.h.

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::operator<= (  const bvector< Alloc, MS > &  bvect  )  const [inline]

Definition at line 908 of file bm.h.

template<class Alloc, class MS> bvector& bm::bvector< Alloc, MS >::operator= (  const bvector< Alloc, MS > &  bvect  )  [inline]

Definition at line 862 of file bm.h. References pythonpp::resize(), and bm::bvector< Alloc, MS >::size().

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::operator== (  const bvector< Alloc, MS > &  bvect  )  const [inline]

Definition at line 923 of file bm.h.

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::operator> (  const bvector< Alloc, MS > &  bvect  )  const [inline]

Definition at line 913 of file bm.h.

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::operator>= (  const bvector< Alloc, MS > &  bvect  )  const [inline]

Definition at line 918 of file bm.h.

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::operator[] (  bm::id_t  n  )  const [inline]

Definition at line 877 of file bm.h. References BM_ASSERT.

template<class Alloc, class MS> reference bm::bvector< Alloc, MS >::operator[] (  bm::id_t  n  )  [inline]

Definition at line 870 of file bm.h. References BM_ASSERT.

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::operator^= (  const bvector< Alloc, MS > &  bvect  )  [inline]

Definition at line 888 of file bm.h.

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::operator|= (  const bvector< Alloc, MS > &  bvect  )  [inline]

Definition at line 893 of file bm.h.

template<class Alloc, class MS> bvector<Alloc, MS> bm::bvector< Alloc, MS >::operator~ (   )  const [inline]

Definition at line 933 of file bm.h.

template<typename Alloc, typename MS> void bm::bvector< Alloc, MS >::optimize (  bm::word_t *  temp_block = 0, optmode  opt_mode = opt_compress, statistics *  stat = 0 )

Optimize memory bitvector's memory allocation. Function analyze all blocks in the bitvector, compresses blocks with a regular structure, frees some memory. This function is recommended after a bulk modification of the bitvector using set_bit, clear_bit or logical operations. Optionally function can calculate vector post optimization statistics See also: optmode, optimize_gap_size Definition at line 1833 of file bm.h. References bm::bv_statistics::bit_blocks, bm::bvector< Alloc, MS >::blockman_, bm::blocks_manager< Alloc, MS >::blocks_root(), bm::blocks_manager< Alloc, MS >::check_allocate_tempblock(), bm::blocks_manager< Alloc, MS >::effective_top_block_size(), bm::for_each_nzblock(), bm::bv_statistics::gap_blocks, bm::gap_levels, bm::bv_statistics::gap_levels, bm::blocks_manager< Alloc, MS >::glen(), bm::bv_statistics::max_serialize_mem, bm::blocks_manager< Alloc, MS >::mem_used(), and bm::bv_statistics::memory_used. Referenced by ComparisonTest(), FillSetsRandomMethod(), CQueue::FlushDeletedVectors(), CWorkerNodeAffinityGuard::GetJobWithAffinities(), CJobStatusTracker::IncDoneJobs(), CQueue::LoadStatusMatrix(), OrOperationsTest(), SerializationOperation(), SerializationTest(), SetTest(), SubOperationsTest(), CQueue::x_RemoveTags(), and CNetScheduleHandler::x_SerializeBitVector().

template<typename Alloc, typename MS> void bm::bvector< Alloc, MS >::optimize_gap_size (   )

Optimize sizes of GAP blocks. This method runs an analysis to find optimal GAP levels for the specific vector. Current GAP compression algorithm uses several fixed GAP sizes. By default bvector uses some reasonable preset. Definition at line 1875 of file bm.h. References bm::bvector< Alloc, MS >::calc_stat(), bm::gap_levels, bm::improve_gap_levels(), and bm::bvector< Alloc, MS >::set_gap_levels().

template<class Alloc, class MS> bm::id_t bm::bvector< Alloc, MS >::recalc_count (   )  [inline]

Definition at line 1122 of file bm.h. References BMCOUNT_VALID. Referenced by CheckVectors(), and bm::bvector< Alloc, MS >::swap().

template<class Alloc, class MS> bvector<Alloc, MS>& bm::bvector< Alloc, MS >::reset (   )  [inline]

Clears every bit in the bitvector. Returns: *this; Definition at line 1058 of file bm.h.

template<typename Alloc, typename MS> void bm::bvector< Alloc, MS >::resize (  size_type  new_size  )

Change size of the bvector. Parameters: new_size  - new size in bits Definition at line 1663 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, bm::blocks_manager< Alloc, MS >::reserve(), bm::bvector< Alloc, MS >::set_range(), and bm::bvector< Alloc, MS >::size_. Referenced by BitString(), CObjectIStreamAsnBinary::ReadBitString(), ResizeTest(), s_SetBSFromOS(), and CAlnStats< _TAlnIdVec >::x_AddId().

template<class Alloc, class MS> bvector<Alloc, MS>& bm::bvector< Alloc, MS >::set (   )  [inline]

Sets every bit in this bitset to 1. Returns: *this Definition at line 1001 of file bm.h. References BMCOUNT_VALID.

template<class Alloc, class MS> bvector<Alloc, MS>& bm::bvector< Alloc, MS >::set (  bm::id_t  n, bool  val = true )  [inline]

Sets bit n if val is true, clears bit n if val is false. Parameters: n  - index of the bit to be set val  - new bit value Returns: *this Definition at line 989 of file bm.h. References bm::set_bit(). Referenced by CWorkerNodeAffinityGuard::AddAffinity(), CQueue::AddJobsToAffinity(), SAffinityInfo::BlacklistJob(), CQueue::ClearAffinityIdx(), CQueue::DeleteBatch(), CLDS_Object::DeleteCascadeFiles(), SAffinityInfo::GetBlacklistedJobs(), CAffinityDict::GetTokensIds(), NS_DecodeBitVector(), CLDS_IdTableScanner::OnRecordFound(), CLDS_FindSeqIdListFunctor::operator()(), CLDS_FindSeqIdFunctor::operator()(), OrOperationsTest(), ResizeTest(), CLDS_Query::ScreenSequence(), CJobStatusTracker::SetExactStatusNoLock(), CNetSchedule_AccessList::SetHosts(), SetTest(), CJobStatusTracker::SwitchJobs(), and CNetScheduleHandler::WriteProjection().

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::set_bit (  bm::id_t  n, bool  val = true )  [inline]

Sets bit n. Parameters: n  - index of the bit to be set. val  - new bit value Returns: TRUE if bit was changed Definition at line 950 of file bm.h. References BM_ASSERT. Referenced by AndOperationsTest(), BasicFunctionalityTest(), BlockLevelTest(), CQueue::CheckJobsExpiry(), ClearAllTest(), ComparisonTest(), DesrializationTest2(), EnumeratorTest(), CQueue::EraseJob(), FillSets(), GetNextTest(), MaxSTest(), MutationOperationsTest(), MutationTest(), OrOperationsTest(), CObjectIStreamAsnBinary::ReadBitString(), SerializationTest(), SimpleRandomFillTest(), SubOperationsTest(), and XorOperationsTest().

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::set_bit_and (  bm::id_t  n, bool  val = true )  [inline]

Sets bit n using bit AND with the provided value. Parameters: n  - index of the bit to be set. val  - new bit value Returns: TRUE if bit was changed Definition at line 962 of file bm.h. References BM_ASSERT.

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::set_bit_conditional (  bm::id_t  n, bool  val, bool  condition )  [inline]

Sets bit n only if current value is equal to the condition. Parameters: n  - index of the bit to be set. val  - new bit value condition  - expected current value Returns: TRUE if bit was changed Definition at line 975 of file bm.h. References BM_ASSERT. Referenced by SetTest().

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::set_bit_conditional_impl (  bm::id_t  n, bool  val, bool  condition )  [private]

Definition at line 2200 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, BM_ASSERT, BMCOUNT_ADJ, BMCOUNT_DEC, BMCOUNT_INC, BMGAP_PTR, bm::blocks_manager< Alloc, MS >::check_allocate_block(), bm::bvector< Alloc, MS >::extend_gap_block(), bm::gap_limit(), bm::gap_set_value(), bm::gap_test(), bm::bvector< Alloc, MS >::get_new_blocks_strat(), bm::blocks_manager< Alloc, MS >::glen(), mask, bm::set_block_mask, bm::set_block_shift, bm::set_word_mask, and bm::set_word_shift.

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::set_bit_no_check (  bm::id_t  n, bool  val )  [private]

Set specified bit without checking preconditions (size, etc). Definition at line 2128 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, BMCOUNT_ADJ, BMCOUNT_DEC, BMCOUNT_INC, BMGAP_PTR, bm::blocks_manager< Alloc, MS >::check_allocate_block(), bm::bvector< Alloc, MS >::extend_gap_block(), bm::gap_limit(), bm::gap_set_value(), bm::bvector< Alloc, MS >::get_new_blocks_strat(), bm::blocks_manager< Alloc, MS >::glen(), mask, bm::set_block_mask, bm::set_block_shift, bm::set_word_mask, and bm::set_word_shift. Referenced by bm::bvector< Alloc, MS >::invert().

template<typename Alloc, typename MS> void bm::bvector< Alloc, MS >::set_gap_levels (  const gap_word_t *  glevel_len  )

Sets new GAP lengths table. All GAP blocks will be reallocated to match the new scheme. Parameters: glevel_len  - pointer on C-style array keeping GAP block sizes. Definition at line 1896 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, bm::blocks_manager< Alloc, MS >::blocks_root(), bm::for_each_nzblock(), bm::blocks_manager< Alloc, MS >::set_glen(), and bm::blocks_manager< Alloc, MS >::top_block_size(). Referenced by bm::bvector< Alloc, MS >::optimize_gap_size().

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::set_new_blocks_strat (  strategy  strat  )  [inline]

Sets new blocks allocation strategy. Parameters: strat  - Strategy code 0 - bitblocks allocation only. 1 - Blocks mutation mode (adaptive algorithm) Definition at line 1322 of file bm.h. Referenced by AndOperationsTest(), BlockLevelTest(), GetNextTest(), MutationOperationsTest(), MutationTest(), OrOperationsTest(), SerializationTest(), SimpleRandomFillTest(), StressTest(), SubOperationsTest(), and XorOperationsTest().

template<typename Alloc, typename MS> bvector< Alloc, MS > & bm::bvector< Alloc, MS >::set_range (  bm::id_t  left, bm::id_t  right, bool  value = true )

Sets all bits in the specified closed interval [left,right] Interval must be inside the bvector's size. This method DOES NOT resize vector. Parameters: left  - interval start right  - interval end (closed interval) value  - value to set interval in Returns: *this Definition at line 1618 of file bm.h. References BM_ASSERT, BMCOUNT_VALID, bm::bvector< Alloc, MS >::set_range_no_check(), and bm::bvector< Alloc, MS >::size_. Referenced by CQueue::AddJobsToAffinity(), CJobStatusTracker::AddPendingBatch(), bm::bvector< Alloc, MS >::combine_operation(), FillSetsIntervals(), bm::bvector< Alloc, MS >::resize(), and ResizeTest().

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::set_range_no_check (  bm::id_t  left, bm::id_t  right, bool  value )  [private]

Set range without validity checking. Definition at line 2926 of file bm.h. References bm::bits_in_block, bm::bvector< Alloc, MS >::blockman_, bm::BM_AND, BM_IS_GAP, bm::BM_OR, BMGAP_PTR, bm::bvector< Alloc, MS >::combine_operation_with_block(), FULL_BLOCK_ADDR, bm::gap_init_range_block(), bm::blocks_manager< Alloc, MS >::get_allocator(), bm::blocks_manager< Alloc, MS >::get_block(), bm::blocks_manager< Alloc, MS >::glen(), IS_FULL_BLOCK, bm::blocks_manager< Alloc, MS >::set_block(), bm::blocks_manager< Alloc, MS >::set_block_bit(), bm::set_block_mask, and bm::set_block_shift. Referenced by bm::bvector< Alloc, MS >::invert(), and bm::bvector< Alloc, MS >::set_range().

template<class Alloc, class MS> size_type bm::bvector< Alloc, MS >::size (  void   )  const [inline]

return current size of the vector (bits) Definition at line 1082 of file bm.h. Referenced by bm::bvector< Alloc, MS >::operator=(), CObjectIStreamXml::ReadBitString(), ResizeTest(), CObjectOStreamAsnBinary::WriteBitString(), CObjectOStreamAsn::WriteBitString(), and CNetScheduleHandler::x_DeserializeBitVector().

template<class Alloc, class MS> void bm::bvector< Alloc, MS >::swap (  bvector< Alloc, MS > &  bv  )  [inline]

Exchanges content of bv and this bitvector. Definition at line 1212 of file bm.h. References bm::bvector< Alloc, MS >::blockman_, BMCOUNT_VALID, bm::bvector< Alloc, MS >::recalc_count(), bm::bvector< Alloc, MS >::size_, and bm::xor_swap(). Referenced by ResizeTest(), and SyntaxTest().

template<class Alloc, class MS> bool bm::bvector< Alloc, MS >::test (  bm::id_t  n  )  const [inline]

returns true if bit n is set and false is bit n is 0. Parameters: n  - Index of the bit to check. Returns: Bit value (1 or 0) Definition at line 1158 of file bm.h. Referenced by CheckIntervals(), and ExportTest().

---

Friends And Related Function Documentation

template<class Alloc, class MS> friend class enumerator [friend]

Definition at line 777 of file bm.h. Referenced by CQueue::CheckExecutionTimeout(), CNetScheduleKeys::const_iterator::const_iterator(), CLDS_File::Delete(), EnumeratorTest(), CQueue::ExecProject(), CLDS_Query::CSequenceFinder::FindInCandidates(), CQueue::GetJobsWithAffinities(), CJobStatusTracker::GetPendingJob(), CJobStatusTracker::GetPendingJobFromSet(), NS_EncodeBitVector(), CNetScheduleKeys::const_iterator::operator++(), CNetSchedule_AccessList::Print(), CNetSchedule_AccessList::PrintHosts(), CQueue::PrintJobDbStat(), CQueue::PrintQueue(), CJobStatusTracker::PrintStatusMatrix(), CQueue::ReadJobs(), ResizeTest(), CJobStatusTracker::SwitchJobs(), and CQueue::x_ChangeGroupStatus().

template<class Alloc, class MS> friend class iterator_base [friend]

Definition at line 776 of file bm.h.

---

Member Data Documentation

template<class Alloc, class MS> blocks_manager_type bm::bvector< Alloc, MS >::blockman_ [private]

bitblocks manager Definition at line 1543 of file bm.h. Referenced by bm::bvector< Alloc, MS >::and_bit_no_check(), bm::bvector< Alloc, MS >::calc_stat(), bm::bvector< Alloc, MS >::check_or_next(), bm::bvector< Alloc, MS >::check_or_next_extract(), bm::bvector< Alloc, MS >::combine_operation(), bm::bvector< Alloc, MS >::combine_operation_with_block(), bm::bvector< Alloc, MS >::compare(), bm::bvector< Alloc, MS >::count(), bm::bvector< Alloc, MS >::count_range(), bm::bvector< Alloc, MS >::get_bit(), bm::bvector< Alloc, MS >::invert(), bm::bvector< Alloc, MS >::optimize(), bm::bvector< Alloc, MS >::resize(), bm::bvector< Alloc, MS >::set_bit_conditional_impl(), bm::bvector< Alloc, MS >::set_bit_no_check(), bm::bvector< Alloc, MS >::set_gap_levels(), bm::bvector< Alloc, MS >::set_range_no_check(), and bm::bvector< Alloc, MS >::swap().

template<class Alloc, class MS> strategy bm::bvector< Alloc, MS >::new_blocks_strat_ [private]

block allocation strategy Definition at line 1544 of file bm.h.

template<class Alloc, class MS> size_type bm::bvector< Alloc, MS >::size_ [private]

size in bits Definition at line 1545 of file bm.h. Referenced by bm::bvector< Alloc, MS >::combine_operation(), bm::bvector< Alloc, MS >::get_bit(), bm::bvector< Alloc, MS >::invert(), bm::bvector< Alloc, MS >::resize(), bm::bvector< Alloc, MS >::set_range(), and bm::bvector< Alloc, MS >::swap().

---

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

• include/util/bitset/bm.h

---