Base class providing core functionality for dynamic bitset implementations. More...

#include <dynamic_bitset_base.hpp>

Inheritance diagram for sparrow::dynamic_bitset_base< B, NCP >:

Collaboration diagram for sparrow::dynamic_bitset_base< B, NCP >:

Public Types
using	self_type = dynamic_bitset_base<B, NCP>
	This class type.

using	null_count_policy_type = NCP
	Null count tracking policy type.

using	storage_type = B
	Underlying storage container type.

using	storage_type_without_cvrefpointer
	Storage type without CV/ref/pointer qualifiers.

using	block_type = typename storage_type_without_cvrefpointer::value_type
	Type of each storage block (integral type)

using	value_type = bool
	Type of individual bit values.

using	reference = bitset_reference<self_type>
	Mutable reference to a bit.

using	const_reference = bool
	Immutable reference to a bit (plain bool)

using	size_type = typename storage_type_without_cvrefpointer::size_type
	Type for sizes and indices.

using	difference_type = typename storage_type_without_cvrefpointer::difference_type
	Type for iterator differences.

using	iterator = bitset_iterator<self_type, false>
	Mutable iterator type.

using	const_iterator = bitset_iterator<self_type, true>
	Immutable iterator type.

Public Member Functions
constexpr size_type	size () const noexcept
	Returns the number of bits in the bitset.

constexpr void	set_size (size_type new_size) noexcept

constexpr size_type	offset () const noexcept
	Returns the bit offset within the buffer.

constexpr void	set_offset (size_type offset) noexcept
	Sets the bit offset within the buffer.

constexpr bool	empty () const noexcept
	Checks if the bitset contains no bits.

constexpr size_type	null_count () const noexcept
	Returns the number of bits set to false (null/invalid).

constexpr bool	test (size_type pos) const
	Tests the value of a bit at the specified position.

constexpr void	set (size_type pos, value_type value)
	Sets the value of a bit at the specified position.

constexpr const_reference	at (size_type pos) const
	Accesses a bit with bounds checking.

constexpr reference	at (size_type pos)
	Accesses a bit with bounds checking.

constexpr reference	operator[] (size_type i)
	Accesses a bit without bounds checking.

constexpr const_reference	operator[] (size_type i) const
	Accesses a bit without bounds checking.

constexpr block_type *	data () noexcept
	Returns a pointer to the underlying block storage.

constexpr const block_type *	data () const noexcept
	Returns a pointer to the underlying block storage.

constexpr size_type	block_count () const noexcept
	Returns the number of storage blocks.

constexpr void	swap (self_type &rhs) noexcept
	Swaps the contents with another bitset.

constexpr iterator	begin ()
	Returns a mutable iterator to the first bit.

constexpr iterator	end ()
	Returns a mutable iterator past the last bit.

constexpr const_iterator	begin () const
	Returns an immutable iterator to the first bit.

constexpr const_iterator	end () const
	Returns an immutable iterator past the last bit.

constexpr const_iterator	cbegin () const
	Returns an immutable iterator to the first bit.

constexpr const_iterator	cend () const
	Returns an immutable iterator past the last bit.

constexpr reference	front ()
	Accesses the first bit.

constexpr const_reference	front () const
	Accesses the first bit.

constexpr reference	back ()
	Accesses the last bit.

constexpr const_reference	back () const
	Accesses the last bit.

constexpr const storage_type_without_cvrefpointer &	buffer () const noexcept
	Returns an immutable reference to the underlying buffer.

constexpr storage_type_without_cvrefpointer &	buffer () noexcept
	Returns a mutable reference to the underlying buffer.

storage_type	extract_storage () noexcept
	Extracts the underlying storage (move operation).

Static Public Member Functions
static constexpr size_type	compute_block_count (size_type bits_count) noexcept
	Computes the number of blocks needed to store the specified number of bits.

Protected Member Functions
constexpr	dynamic_bitset_base (storage_type buffer, size_type size)
	Constructs a bitset with the given storage and size.

constexpr	dynamic_bitset_base (storage_type buffer, size_type size, size_type offset)
	Constructs a bitset with the given storage, size, and null count.

constexpr	dynamic_bitset_base (storage_type buffer, size_type size, size_type offset, size_type null_count)
	Constructs a bitset with the given storage, size, offset, and null count.

constexpr	~dynamic_bitset_base ()=default

constexpr	dynamic_bitset_base (const dynamic_bitset_base &)=default

constexpr	dynamic_bitset_base (dynamic_bitset_base &&) noexcept=default

constexpr dynamic_bitset_base &	operator= (const dynamic_bitset_base &)=default

constexpr dynamic_bitset_base &	operator= (dynamic_bitset_base &&) noexcept=default

constexpr void	resize (size_type n, value_type b=false)
	Resizes the bitset to contain n bits.

constexpr void	clear () noexcept
	Removes all bits from the bitset.

constexpr iterator	insert (const_iterator pos, value_type value)
	Inserts a single bit at the specified position.

constexpr iterator	insert (const_iterator pos, size_type count, value_type value)
	Inserts multiple bits with the same value at the specified position.

template<std::input_iterator InputIt> requires std::ranges::random_access_range<std::remove_pointer_t<B>>
constexpr iterator	insert (const_iterator pos, InputIt first, InputIt last)
	Inserts bits from an iterator range at the specified position.

constexpr iterator	insert (const_iterator pos, std::initializer_list< value_type > ilist)
	Inserts bits from an initializer list at the specified position.

constexpr iterator	emplace (const_iterator pos, value_type value)
	Constructs a bit in-place at the specified position.

constexpr iterator	erase (const_iterator pos)
	Removes a single bit at the specified position.

constexpr iterator	erase (const_iterator first, const_iterator last)
	Removes bits in the specified range.

constexpr void	push_back (value_type value)
	Adds a bit to the end of the bitset.

constexpr void	pop_back ()
	Removes the last bit from the bitset.

constexpr void	zero_unused_bits ()
	Clears any unused bits in the last storage block.

Protected Member Functions inherited from sparrow::tracking_null_count< SizeType >
constexpr	tracking_null_count () noexcept=default

constexpr	tracking_null_count (size_type count) noexcept

template<std::integral BlockType>
void	initialize_null_count (const BlockType *data, size_type bit_size, size_type block_count, size_type offset=0) noexcept
	Initializes the null count by counting bits in the buffer.

constexpr size_type	null_count () const noexcept

constexpr void	set_null_count (size_type count) noexcept

template<std::integral BlockType>
void	recompute_null_count (const BlockType *data, size_type bit_size, size_type block_count, size_type offset=0) noexcept
	Recomputes the null count from the buffer.

constexpr void	update_null_count (bool old_value, bool new_value) noexcept

constexpr void	swap_null_count (tracking_null_count &other) noexcept

constexpr void	clear_null_count () noexcept

Friends
class	bitset_iterator< self_type, true >
	Const iterator needs access to internals.

class	bitset_iterator< self_type, false >
	Mutable iterator needs access to internals.

class	bitset_reference< self_type >
	Bit reference needs access to internals.

Additional Inherited Members
Protected Types inherited from sparrow::tracking_null_count< SizeType >
using	size_type = SizeType

Static Protected Attributes inherited from sparrow::tracking_null_count< SizeType >
static constexpr bool	track_null_count = true

Detailed Description

template<typename B, null_count_policy NCP = tracking_null_count<>>
requires std::ranges::random_access_range<std::remove_pointer_t>
class sparrow::dynamic_bitset_base< B, NCP >

Base class providing core functionality for dynamic bitset implementations.

This template class serves as the foundation for both dynamic_bitset and dynamic_bitset_view, providing a comprehensive API for manipulating sequences of bits stored in memory blocks. The key difference between derived classes is memory ownership: dynamic_bitset owns and manages its storage, while dynamic_bitset_view provides a non-owning view.

The class efficiently stores bits using blocks of integral types, with specialized algorithms for bit manipulation, counting, and iteration. It supports all standard container operations including insertion, deletion, resizing, and element access.

Template Parameters

B	The underlying storage type, which must be a random access range. Typically buffer<T> for owning storage or buffer_view<T> for non-owning views. The value_type of B must be an integral type used as storage blocks.

Note: This class tracks both the total size and null count for efficient validity checking in data processing scenarios where null/invalid values are common.; The class uses bit-level operations and assumes little-endian bit ordering within blocks.

Example usage through derived classes:

//Through dynamic_bitset (owning)
dynamic_bitset<std::uint8_t> bits(100, false);
bits.set(50, true);
bool value = bits.test(50);
 
//Through dynamic_bitset_view (non-owning)
std::vector<std::uint8_t> buffer(16, 0);
dynamic_bitset_view<std::uint8_t> view(buffer.data(), 128);
view.set(64, true);

Definition at line 68 of file dynamic_bitset_base.hpp.

Member Typedef Documentation

◆ block_type

template<typename B, null_count_policy NCP = tracking_null_count<>>

using sparrow::dynamic_bitset_base< B, NCP >::block_type = typename storage_type_without_cvrefpointer::value_type

Type of each storage block (integral type)

Definition at line 77 of file dynamic_bitset_base.hpp.

◆ const_iterator

template<typename B, null_count_policy NCP = tracking_null_count<>>

using sparrow::dynamic_bitset_base< B, NCP >::const_iterator = bitset_iterator<self_type, true>

Immutable iterator type.

Definition at line 88 of file dynamic_bitset_base.hpp.

◆ const_reference

template<typename B, null_count_policy NCP = tracking_null_count<>>

using sparrow::dynamic_bitset_base< B, NCP >::const_reference = bool

Immutable reference to a bit (plain bool)

Definition at line 81 of file dynamic_bitset_base.hpp.

◆ difference_type

template<typename B, null_count_policy NCP = tracking_null_count<>>

using sparrow::dynamic_bitset_base< B, NCP >::difference_type = typename storage_type_without_cvrefpointer::difference_type

Type for iterator differences.

Definition at line 84 of file dynamic_bitset_base.hpp.

◆ iterator

template<typename B, null_count_policy NCP = tracking_null_count<>>

using sparrow::dynamic_bitset_base< B, NCP >::iterator = bitset_iterator<self_type, false>

Mutable iterator type.

Definition at line 87 of file dynamic_bitset_base.hpp.

◆ null_count_policy_type

template<typename B, null_count_policy NCP = tracking_null_count<>>

using sparrow::dynamic_bitset_base< B, NCP >::null_count_policy_type = NCP

Null count tracking policy type.

Definition at line 73 of file dynamic_bitset_base.hpp.

◆ reference

template<typename B, null_count_policy NCP = tracking_null_count<>>

using sparrow::dynamic_bitset_base< B, NCP >::reference = bitset_reference<self_type>

Mutable reference to a bit.

Definition at line 80 of file dynamic_bitset_base.hpp.

◆ self_type

template<typename B, null_count_policy NCP = tracking_null_count<>>

using sparrow::dynamic_bitset_base< B, NCP >::self_type = dynamic_bitset_base<B, NCP>

This class type.

Definition at line 72 of file dynamic_bitset_base.hpp.

◆ size_type

template<typename B, null_count_policy NCP = tracking_null_count<>>

using sparrow::dynamic_bitset_base< B, NCP >::size_type = typename storage_type_without_cvrefpointer::size_type

Type for sizes and indices.

Definition at line 82 of file dynamic_bitset_base.hpp.

◆ storage_type

template<typename B, null_count_policy NCP = tracking_null_count<>>

using sparrow::dynamic_bitset_base< B, NCP >::storage_type = B

Underlying storage container type.

Definition at line 74 of file dynamic_bitset_base.hpp.

◆ storage_type_without_cvrefpointer

template<typename B, null_count_policy NCP = tracking_null_count<>>

using sparrow::dynamic_bitset_base< B, NCP >::storage_type_without_cvrefpointer

Initial value:

std::remove_pointer_t<

std::remove_cvref_t<storage_type>>

Storage type without CV/ref/pointer qualifiers.

Definition at line 75 of file dynamic_bitset_base.hpp.

◆ value_type

template<typename B, null_count_policy NCP = tracking_null_count<>>

using sparrow::dynamic_bitset_base< B, NCP >::value_type = bool

Type of individual bit values.

Definition at line 79 of file dynamic_bitset_base.hpp.

Constructor & Destructor Documentation

◆ dynamic_bitset_base() [1/5]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

sparrow::dynamic_bitset_base< B, NCP >::dynamic_bitset_base	(	storage_type	buffer,
		size_type	size )

constexprprotected

Constructs a bitset with the given storage and size.

Parameters

buffer	The storage buffer to use
size	The number of bits in the bitset

Postcondition: size() == size; offset() == 0; null_count() is computed by counting unset bits

Definition at line 876 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dynamic_bitset_base() [2/5]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

sparrow::dynamic_bitset_base< B, NCP >::dynamic_bitset_base	(	storage_type	buffer,
		size_type	size,
		size_type	offset )

constexprprotected

Constructs a bitset with the given storage, size, and null count.

Parameters

buffer	The storage buffer to use
size	The number of bits in the bitset
offset	The offset in bits from the start of the buffer

Precondition: null_count <= size

Postcondition: size() == size; null_count() == null_count

Note: Only available when using tracking_null_count policy

Definition at line 886 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ dynamic_bitset_base() [3/5]

template<typename B, null_count_policy NCP>
requires (NCP::track_null_count)

sparrow::dynamic_bitset_base< B, NCP >::dynamic_bitset_base	(	storage_type	buffer,
		size_type	size,
		size_type	offset,
		size_type	null_count )

constexprprotected

Constructs a bitset with the given storage, size, offset, and null count.

Parameters

buffer	The storage buffer to use
size	The number of bits in the bitset
offset	The offset in bits from the start of the buffer
null_count	The number of unset bits

Precondition: null_count <= size

Postcondition: size() == size; offset() == offset; null_count() == null_count

Note: Only available when using tracking_null_count policy

Definition at line 896 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ ~dynamic_bitset_base()

template<typename B, null_count_policy NCP = tracking_null_count<>>

sparrow::dynamic_bitset_base< B, NCP >::~dynamic_bitset_base ( )

constexprprotecteddefault

◆ dynamic_bitset_base() [4/5]

template<typename B, null_count_policy NCP = tracking_null_count<>>

sparrow::dynamic_bitset_base< B, NCP >::dynamic_bitset_base ( const dynamic_bitset_base< B, NCP > & )

constexprprotecteddefault

◆ dynamic_bitset_base() [5/5]

template<typename B, null_count_policy NCP = tracking_null_count<>>

sparrow::dynamic_bitset_base< B, NCP >::dynamic_bitset_base ( dynamic_bitset_base< B, NCP > && )

constexprprotecteddefaultnoexcept

Member Function Documentation

◆ at() [1/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::at ( size_type pos )

nodiscardconstexpr

Accesses a bit with bounds checking.

Parameters

pos	The position of the bit to access

Returns: Mutable reference to the bit

Precondition: pos < size()

Postcondition: Return value allows modification of the bit at position pos

Exceptions

std::out_of_range if pos >= size()

Definition at line 808 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ at() [2/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::at ( size_type pos ) const

nodiscardconstexpr

Accesses a bit with bounds checking.

Parameters

pos	The position of the bit to access

Returns: Immutable reference to the bit value

Precondition: pos < size()

Postcondition: Return value represents the bit at position pos

Exceptions

std::out_of_range if pos >= size()

Definition at line 822 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ back() [1/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::back ( )

nodiscardconstexpr

Accesses the last bit.

Returns: Mutable reference to the last bit

Precondition: size() >= 1

Postcondition: Return value allows modification of the bit at position size()-1

Note: Asserts that the bitset is not empty in debug builds

Definition at line 856 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ back() [2/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::back ( ) const

nodiscardconstexpr

Accesses the last bit.

Returns: The value of the last bit

Precondition: size() >= 1

Postcondition: Return value represents the bit at position size()-1

Note: Asserts that the bitset is not empty in debug builds; Returns true for null buffers

Definition at line 864 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ begin() [1/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::begin ( )

nodiscardconstexpr

Returns a mutable iterator to the first bit.

Returns: Iterator pointing to the first bit

Postcondition: Return value points to position 0 or equals end() if empty

Definition at line 766 of file dynamic_bitset_base.hpp.

◆ begin() [2/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::begin ( ) const

nodiscardconstexpr

Returns an immutable iterator to the first bit.

Returns: Const iterator pointing to the first bit

Postcondition: Return value points to position 0 or equals end() if empty

Definition at line 780 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ block_count()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::block_count ( ) const

nodiscardconstexprnoexcept

Returns the number of storage blocks.

Returns: The number of blocks used to store the bits

Postcondition: Return value >= compute_block_count(size())

Definition at line 748 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buffer() [1/2]

template<typename B, null_count_policy NCP = tracking_null_count<>>

const storage_type_without_cvrefpointer & sparrow::dynamic_bitset_base< B, NCP >::buffer ( ) const

inlinenodiscardconstexprnoexcept

Returns an immutable reference to the underlying buffer.

Returns: Reference to the storage buffer

Postcondition: Return value provides access to the underlying storage

Definition at line 309 of file dynamic_bitset_base.hpp.

Here is the caller graph for this function:

◆ buffer() [2/2]

template<typename B, null_count_policy NCP = tracking_null_count<>>

storage_type_without_cvrefpointer & sparrow::dynamic_bitset_base< B, NCP >::buffer ( )

inlinenodiscardconstexprnoexcept

Returns a mutable reference to the underlying buffer.

Returns: Reference to the storage buffer

Postcondition: Return value provides mutable access to the underlying storage

Definition at line 326 of file dynamic_bitset_base.hpp.

◆ cbegin()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::cbegin ( ) const

nodiscardconstexpr

Returns an immutable iterator to the first bit.

Returns: Const iterator pointing to the first bit

Postcondition: Return value points to position 0 or equals cend() if empty

Definition at line 794 of file dynamic_bitset_base.hpp.

Here is the caller graph for this function:

◆ cend()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::cend ( ) const

nodiscardconstexpr

Returns an immutable iterator past the last bit.

Returns: Const iterator pointing past the last bit

Postcondition: Return value points to position size()

Definition at line 801 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

void sparrow::dynamic_bitset_base< B, NCP >::clear ( )

constexprprotectednoexcept

Removes all bits from the bitset.

Postcondition: size() == 0; empty() == true; null_count() == 0

Definition at line 1023 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ compute_block_count()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::compute_block_count ( size_type bits_count )

staticnodiscardconstexprnoexcept

Computes the number of blocks needed to store the specified number of bits.

Parameters

bits_count The number of bits to store

Returns: The minimum number of blocks required

Postcondition: Return value >= (bits_count + bits_per_block - 1) / bits_per_block; Return value is 0 if bits_count is 0

Definition at line 912 of file dynamic_bitset_base.hpp.

Here is the caller graph for this function:

◆ data() [1/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::data ( ) const

nodiscardconstexprnoexcept

Returns a pointer to the underlying block storage.

Returns: Immutable pointer to the first block, or nullptr if storage is null

Postcondition: Return value points to valid memory or is nullptr

Definition at line 741 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ data() [2/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::data ( )

nodiscardconstexprnoexcept

Returns a pointer to the underlying block storage.

Returns: Mutable pointer to the first block, or nullptr if storage is null

Postcondition: Return value points to valid memory or is nullptr

Definition at line 727 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ emplace()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

dynamic_bitset_base< B, NCP >::iterator sparrow::dynamic_bitset_base< B, NCP >::emplace	(	const_iterator	pos,
		value_type	value )

constexprprotected

Constructs a bit in-place at the specified position.

Parameters

pos	Iterator pointing to the insertion position
value	The value of the bit to emplace

Returns: Iterator pointing to the emplaced bit

Precondition: cbegin() <= pos <= cend()

Postcondition: size() increases by 1

Note: Equivalent to insert(pos, value) for bool values

Definition at line 1127 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ empty()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

bool sparrow::dynamic_bitset_base< B, NCP >::empty ( ) const

nodiscardconstexprnoexcept

Checks if the bitset contains no bits.

Returns: true if size() == 0, false otherwise

Postcondition: Return value is equivalent to (size() == 0)

Definition at line 604 of file dynamic_bitset_base.hpp.

Here is the caller graph for this function:

◆ end() [1/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::end ( )

nodiscardconstexpr

Returns a mutable iterator past the last bit.

Returns: Iterator pointing past the last bit

Postcondition: Return value points to position size()

Definition at line 773 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ end() [2/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::end ( ) const

nodiscardconstexpr

Returns an immutable iterator past the last bit.

Returns: Const iterator pointing past the last bit

Postcondition: Return value points to position size()

Definition at line 787 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ erase() [1/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

dynamic_bitset_base< B, NCP >::iterator sparrow::dynamic_bitset_base< B, NCP >::erase	(	const_iterator	first,
		const_iterator	last )

constexprprotected

Removes bits in the specified range.

Parameters

first	Iterator pointing to the first bit to remove
last	Iterator pointing past the last bit to remove

Returns: Iterator pointing to the bit following the removed range

Precondition: cbegin() <= first <= last <= cend()

Postcondition: size() decreases by distance(first, last)

Note: Asserts that iterators form a valid range in debug builds

Definition at line 1145 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ erase() [2/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

dynamic_bitset_base< B, NCP >::iterator sparrow::dynamic_bitset_base< B, NCP >::erase ( const_iterator pos )

constexprprotected

Removes a single bit at the specified position.

Parameters

pos	Iterator pointing to the bit to remove

Returns: Iterator pointing to the bit following the removed bit

Precondition: cbegin() <= pos < cend()

Postcondition: size() decreases by 1

Note: Asserts that pos is within valid range in debug builds

Definition at line 1134 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ extract_storage()

template<typename B, null_count_policy NCP = tracking_null_count<>>

storage_type sparrow::dynamic_bitset_base< B, NCP >::extract_storage ( )

inlinenodiscardnoexcept

Extracts the underlying storage (move operation).

Returns: The moved storage object

Precondition: Storage type must be a value type (not a pointer or reference)

Postcondition: The bitset becomes invalid and should not be used after this call

Note: Only available when storage_type is the same as storage_type_without_cvrefpointer

Definition at line 354 of file dynamic_bitset_base.hpp.

◆ front() [1/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::front ( )

nodiscardconstexpr

Accesses the first bit.

Returns: Mutable reference to the first bit

Precondition: size() >= 1

Postcondition: Return value allows modification of the bit at position 0

Note: Asserts that the bitset is not empty in debug builds

Definition at line 836 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ front() [2/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::front ( ) const

nodiscardconstexpr

Accesses the first bit.

Returns: The value of the first bit

Precondition: size() >= 1

Postcondition: Return value represents the bit at position 0

Note: Asserts that the bitset is not empty in debug builds; Returns true for null buffers

Definition at line 844 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ insert() [1/4]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

template<std::input_iterator InputIt>
requires std::ranges::random_access_range<std::remove_pointer_t>

dynamic_bitset_base< B, NCP >::iterator sparrow::dynamic_bitset_base< B, NCP >::insert	(	const_iterator	pos,
		InputIt	first,
		InputIt	last )

constexprprotected

Inserts bits from an iterator range at the specified position.

Template Parameters

InputIt Input iterator type

Parameters

pos	Iterator pointing to the insertion position
first	Iterator pointing to the first bit to insert
last	Iterator pointing past the last bit to insert

Returns: Iterator pointing to the first inserted bit

Precondition: cbegin() <= pos <= cend(); first and last form a valid iterator range

Postcondition: size() increases by distance(first, last)

Note: Asserts that pos is within valid range in debug builds

Definition at line 1078 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ insert() [2/4]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

dynamic_bitset_base< B, NCP >::iterator sparrow::dynamic_bitset_base< B, NCP >::insert	(	const_iterator	pos,
		size_type	count,
		value_type	value )

constexprprotected

Inserts multiple bits with the same value at the specified position.

Parameters

pos	Iterator pointing to the insertion position
count	The number of bits to insert
value	The value of the bits to insert

Returns: Iterator pointing to the first inserted bit

Precondition: cbegin() <= pos <= cend()

Postcondition: size() increases by count; All inserted bits have value 'value'

Note: Asserts that pos is within valid range in debug builds

Definition at line 1041 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ insert() [3/4]

template<typename B, null_count_policy NCP = tracking_null_count<>>

iterator sparrow::dynamic_bitset_base< B, NCP >::insert	(	const_iterator	pos,
		std::initializer_list< value_type >	ilist )

constexprprotected

Inserts bits from an initializer list at the specified position.

Parameters

pos	Iterator pointing to the insertion position
ilist	Initializer list containing the bits to insert

Returns: Iterator pointing to the first inserted bit

Precondition: cbegin() <= pos <= cend()

Postcondition: size() increases by ilist.size()

◆ insert() [4/4]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

dynamic_bitset_base< B, NCP >::iterator sparrow::dynamic_bitset_base< B, NCP >::insert	(	const_iterator	pos,
		value_type	value )

constexprprotected

Inserts a single bit at the specified position.

Parameters

pos	Iterator pointing to the insertion position
value	The value of the bit to insert

Returns: Iterator pointing to the inserted bit

Precondition: cbegin() <= pos <= cend()

Postcondition: size() increases by 1; The bit at the returned iterator position has value 'value'

Note: Asserts that pos is within valid range in debug builds

Definition at line 1033 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ null_count()

template<typename B, null_count_policy NCP>
requires (NCP::track_null_count)

auto sparrow::dynamic_bitset_base< B, NCP >::null_count ( ) const

nodiscardconstexprnoexcept

Returns the number of bits set to false (null/invalid).

Returns: The count of unset bits

Postcondition: Return value <= size()

Note: Only available when using tracking_null_count policy

Definition at line 625 of file dynamic_bitset_base.hpp.

Here is the caller graph for this function:

◆ offset()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::offset ( ) const

nodiscardconstexprnoexcept

Returns the bit offset within the buffer.

Returns: The offset in bits from the start of the buffer

Postcondition: Return value is non-negative

Definition at line 611 of file dynamic_bitset_base.hpp.

Here is the caller graph for this function:

◆ operator=() [1/2]

template<typename B, null_count_policy NCP = tracking_null_count<>>

dynamic_bitset_base & sparrow::dynamic_bitset_base< B, NCP >::operator= ( const dynamic_bitset_base< B, NCP > & )

constexprprotecteddefault

◆ operator=() [2/2]

template<typename B, null_count_policy NCP = tracking_null_count<>>

dynamic_bitset_base & sparrow::dynamic_bitset_base< B, NCP >::operator= ( dynamic_bitset_base< B, NCP > && )

constexprprotecteddefaultnoexcept

◆ operator[]() [1/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::operator[] ( size_type i )

nodiscardconstexpr

Accesses a bit without bounds checking.

Parameters

i	The position of the bit to access

Returns: Mutable reference to the bit

Precondition: i < size()

Postcondition: Return value allows modification of the bit at position i

Note: Asserts that i is within bounds in debug builds

Definition at line 633 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ operator[]() [2/2]

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

bool sparrow::dynamic_bitset_base< B, NCP >::operator[] ( size_type i ) const

nodiscardconstexpr

Accesses a bit without bounds checking.

Parameters

i	The position of the bit to access

Returns: The value of the bit

Precondition: i < size()

Postcondition: Return value represents the bit at position i

Note: Asserts that i is within bounds in debug builds

Definition at line 641 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ pop_back()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

void sparrow::dynamic_bitset_base< B, NCP >::pop_back ( )

constexprprotected

Removes the last bit from the bitset.

Precondition: !empty()

Postcondition: size() decreases by 1 (if not empty)

Note: Does nothing if the bitset is empty

Definition at line 1193 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ push_back()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

void sparrow::dynamic_bitset_base< B, NCP >::push_back ( value_type value )

constexprprotected

Adds a bit to the end of the bitset.

Parameters

value The value of the bit to add

Postcondition: size() increases by 1; back() == value

Definition at line 1186 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ resize()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

void sparrow::dynamic_bitset_base< B, NCP >::resize	(	size_type	n,
		value_type	b = false )

constexprprotected

Resizes the bitset to contain n bits.

Parameters

n	The new size in bits
b	The value to initialize new bits with (default false)

Postcondition: size() == n; New bits (if any) are set to value b

Note: May allocate additional storage blocks if needed; Preserves existing bits when growing

Definition at line 963 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

void sparrow::dynamic_bitset_base< B, NCP >::set	(	size_type	pos,
		value_type	value )

constexpr

Sets the value of a bit at the specified position.

Parameters

pos	The position of the bit to set
value	The value to set (true or false)

Precondition: pos < size()

Postcondition: test(pos) == value

Note: Asserts that pos is within bounds in debug builds; May allocate storage if setting false on a null buffer and storage supports resize

Exceptions

std::runtime_error if trying to set false on a non-resizable null buffer

Definition at line 670 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_offset()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

void sparrow::dynamic_bitset_base< B, NCP >::set_offset ( size_type offset )

constexprnoexcept

Sets the bit offset within the buffer.

Parameters

offset The new offset in bits from the start of the buffer

Postcondition: offset() == offset

Note: For resizable buffers, subsequent bit access operations will automatically resize the buffer if needed to accommodate size() + offset bits.; For non-resizable buffers, ensure the buffer has capacity >= compute_block_count(size() + offset) before accessing bits.

Definition at line 618 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

◆ set_size()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

void sparrow::dynamic_bitset_base< B, NCP >::set_size ( size_type new_size )

constexprnoexcept

Definition at line 597 of file dynamic_bitset_base.hpp.

◆ size()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

auto sparrow::dynamic_bitset_base< B, NCP >::size ( ) const

nodiscardconstexprnoexcept

Returns the number of bits in the bitset.

Returns: The total number of bits stored

Postcondition: Return value is non-negative

Definition at line 590 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ swap()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

void sparrow::dynamic_bitset_base< B, NCP >::swap ( self_type & rhs )

constexprnoexcept

Swaps the contents with another bitset.

Parameters

rhs	The other bitset to swap with

Postcondition: This bitset contains the former contents of rhs; rhs contains the former contents of this bitset

Definition at line 755 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ test()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

bool sparrow::dynamic_bitset_base< B, NCP >::test ( size_type pos ) const

nodiscardconstexpr

Tests the value of a bit at the specified position.

Parameters

pos	The position of the bit to test

Returns: true if the bit is set, false otherwise

Precondition: pos < size()

Note: Asserts that pos is within bounds in debug builds; Returns true for null buffers (all bits assumed set)

Definition at line 648 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ zero_unused_bits()

template<typename B, null_count_policy NCP>
requires std::ranges::random_access_range<std::remove_pointer_t>

void sparrow::dynamic_bitset_base< B, NCP >::zero_unused_bits ( )

constexprprotected

Clears any unused bits in the last storage block.

Postcondition: Unused bits in the last block are set to 0

Note: This ensures consistent behavior and correct bit counting

Definition at line 948 of file dynamic_bitset_base.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ bitset_iterator< self_type, false >

template<typename B, null_count_policy NCP = tracking_null_count<>>

friend class bitset_iterator< self_type, false >

friend

Mutable iterator needs access to internals.

Definition at line 581 of file dynamic_bitset_base.hpp.

◆ bitset_iterator< self_type, true >

template<typename B, null_count_policy NCP = tracking_null_count<>>

friend class bitset_iterator< self_type, true >

friend

Const iterator needs access to internals.

Definition at line 581 of file dynamic_bitset_base.hpp.

◆ bitset_reference< self_type >

template<typename B, null_count_policy NCP = tracking_null_count<>>

friend class bitset_reference< self_type >

friend

Bit reference needs access to internals.

Definition at line 581 of file dynamic_bitset_base.hpp.

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

sparrow/buffer/dynamic_bitset/dynamic_bitset_base.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ block_type

◆ const_iterator

◆ const_reference

◆ difference_type

◆ iterator

◆ null_count_policy_type

◆ reference

◆ self_type

◆ size_type

◆ storage_type

◆ storage_type_without_cvrefpointer

◆ value_type

Constructor & Destructor Documentation

◆ dynamic_bitset_base() [1/5]

◆ dynamic_bitset_base() [2/5]

◆ dynamic_bitset_base() [3/5]

◆ ~dynamic_bitset_base()

◆ dynamic_bitset_base() [4/5]

◆ dynamic_bitset_base() [5/5]

Member Function Documentation

◆ at() [1/2]

◆ at() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ block_count()

◆ buffer() [1/2]

◆ buffer() [2/2]

◆ cbegin()

◆ cend()

◆ clear()

◆ compute_block_count()

◆ data() [1/2]

◆ data() [2/2]

◆ emplace()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ erase() [1/2]

◆ erase() [2/2]

◆ extract_storage()

◆ front() [1/2]

◆ front() [2/2]

◆ insert() [1/4]

◆ insert() [2/4]

◆ insert() [3/4]

◆ insert() [4/4]

◆ null_count()

◆ offset()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pop_back()

◆ push_back()

◆ resize()

◆ set()

◆ set_offset()

◆ set_size()

◆ size()

◆ swap()

◆ test()

◆ zero_unused_bits()

Friends And Related Symbol Documentation

◆ bitset_iterator< self_type, false >

◆ bitset_iterator< self_type, true >

◆ bitset_reference< self_type >