sparrow::non_owning_dynamic_bitset< T, NCP > Class Template Reference

#include <non_owning_dynamic_bitset.hpp>

Inheritance diagram for sparrow::non_owning_dynamic_bitset< T, NCP >:

Collaboration diagram for sparrow::non_owning_dynamic_bitset< T, NCP >:

Public Types
using	base_type = dynamic_bitset_base<buffer<T>*, NCP>
using	storage_type = typename base_type::storage_type
using	block_type = typename base_type::block_type
using	value_type = typename base_type::value_type
using	size_type = typename base_type::size_type
Public Types inherited from sparrow::dynamic_bitset_base< buffer< T > *, tracking_null_count<> >
using	self_type
	This class type.
using	null_count_policy_type
	Null count tracking policy type.
using	storage_type
	Underlying storage container type.
using	storage_type_without_cvrefpointer
	Storage type without CV/ref/pointer qualifiers.
using	block_type
	Type of each storage block (integral type).
using	value_type
	Type of individual bit values.
using	reference
	Mutable reference to a bit.
using	const_reference
	Immutable reference to a bit (plain bool).
using	size_type
	Type for sizes and indices.
using	difference_type
	Type for iterator differences.
using	iterator
	Mutable iterator type.
using	const_iterator
	Immutable iterator type.

Public Member Functions
constexpr	non_owning_dynamic_bitset (buffer< T > *buffer, size_type n)
constexpr	non_owning_dynamic_bitset (buffer< T > *buffer, size_type n, size_type offset)
constexpr	non_owning_dynamic_bitset (buffer< T > *buffer, size_type n, size_type offset, size_type null_count)
constexpr	~non_owning_dynamic_bitset ()=default
constexpr	non_owning_dynamic_bitset (const non_owning_dynamic_bitset &)=default
constexpr	non_owning_dynamic_bitset (non_owning_dynamic_bitset &&) noexcept=default
constexpr non_owning_dynamic_bitset &	operator= (const non_owning_dynamic_bitset &)=default
constexpr non_owning_dynamic_bitset &	operator= (non_owning_dynamic_bitset &&) noexcept=default
constexpr void	clear () noexcept
	Removes all bits from the bitset.
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 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.
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 void	pop_back ()
	Removes the last bit from the bitset.
constexpr void	push_back (value_type value)
	Adds a bit to the end of the bitset.
constexpr void	resize (size_type n, value_type b=false)
	Resizes the bitset to contain n bits.
Public Member Functions inherited from sparrow::dynamic_bitset_base< buffer< T > *, tracking_null_count<> >
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	operator[] (size_type i)
	Accesses a bit without bounds checking.
constexpr block_type *	data () 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	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 reference	back ()
	Accesses the last bit.
constexpr const storage_type_without_cvrefpointer &	buffer () const noexcept
	Returns an immutable reference to the underlying buffer.
storage_type	extract_storage () noexcept
	Extracts the underlying storage (move operation).

Additional Inherited Members
Static Public Member Functions inherited from sparrow::dynamic_bitset_base< buffer< T > *, tracking_null_count<> >
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 inherited from sparrow::dynamic_bitset_base< buffer< T > *, tracking_null_count<> >
constexpr	dynamic_bitset_base (storage_type buffer, size_type size)
	Constructs a bitset with the given storage and size.
constexpr	~dynamic_bitset_base ()=default
constexpr dynamic_bitset_base &	operator= (const dynamic_bitset_base &)=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	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 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.

Detailed Description

template<std::integral T, null_count_policy NCP = tracking_null_count<>>
class sparrow::non_owning_dynamic_bitset< T, NCP >

Definition at line 23 of file non_owning_dynamic_bitset.hpp.

Member Typedef Documentation

base_type

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

using sparrow::non_owning_dynamic_bitset< T, NCP >::base_type = dynamic_bitset_base<buffer<T>*, NCP>

Definition at line 27 of file non_owning_dynamic_bitset.hpp.

block_type

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

using sparrow::non_owning_dynamic_bitset< T, NCP >::block_type = typename base_type::block_type

Definition at line 29 of file non_owning_dynamic_bitset.hpp.

size_type

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

using sparrow::non_owning_dynamic_bitset< T, NCP >::size_type = typename base_type::size_type

Definition at line 31 of file non_owning_dynamic_bitset.hpp.

storage_type

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

using sparrow::non_owning_dynamic_bitset< T, NCP >::storage_type = typename base_type::storage_type

Definition at line 28 of file non_owning_dynamic_bitset.hpp.

value_type

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

using sparrow::non_owning_dynamic_bitset< T, NCP >::value_type = typename base_type::value_type

Definition at line 30 of file non_owning_dynamic_bitset.hpp.

Constructor & Destructor Documentation

non_owning_dynamic_bitset() [1/5]

template<std::integral T, null_count_policy NCP>

sparrow::non_owning_dynamic_bitset< T, NCP >::non_owning_dynamic_bitset ( buffer< T > * buffer, size_type n )

explicitconstexpr

Definition at line 56 of file non_owning_dynamic_bitset.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

non_owning_dynamic_bitset() [2/5]

template<std::integral T, null_count_policy NCP>

sparrow::non_owning_dynamic_bitset< T, NCP >::non_owning_dynamic_bitset ( buffer< T > * buffer, size_type n, size_type offset )

explicitconstexpr

Definition at line 63 of file non_owning_dynamic_bitset.hpp.

Here is the call graph for this function:

non_owning_dynamic_bitset() [3/5]

template<std::integral T, null_count_policy NCP>
requires (NCP::track_null_count)

sparrow::non_owning_dynamic_bitset< T, NCP >::non_owning_dynamic_bitset ( buffer< T > * buffer, size_type n, size_type offset, size_type null_count )

explicitconstexpr

Definition at line 74 of file non_owning_dynamic_bitset.hpp.

Here is the call graph for this function:

~non_owning_dynamic_bitset()

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

sparrow::non_owning_dynamic_bitset< T, NCP >::~non_owning_dynamic_bitset ( )

constexprdefault

non_owning_dynamic_bitset() [4/5]

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

sparrow::non_owning_dynamic_bitset< T, NCP >::non_owning_dynamic_bitset ( const non_owning_dynamic_bitset< T, NCP > & )

constexprdefault

non_owning_dynamic_bitset() [5/5]

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

sparrow::non_owning_dynamic_bitset< T, NCP >::non_owning_dynamic_bitset ( non_owning_dynamic_bitset< T, NCP > && )

constexprdefaultnoexcept

Member Function Documentation

clear()

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

void sparrow::dynamic_bitset_base< buffer< T > *, NCP >::clear ( )

constexprnoexcept

Removes all bits from the bitset.

Postcondition

size() == 0

empty() == true

null_count() == 0

emplace()

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

iterator sparrow::dynamic_bitset_base< buffer< T > *, NCP >::emplace ( const_iterator pos, value_type value )

constexpr

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

erase() [1/2]

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

iterator sparrow::dynamic_bitset_base< buffer< T > *, NCP >::erase ( const_iterator first, const_iterator last )

constexpr

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

erase() [2/2]

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

iterator sparrow::dynamic_bitset_base< buffer< T > *, NCP >::erase ( const_iterator pos )

constexpr

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

insert() [1/4]

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

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

constexpr

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

insert() [2/4]

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

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

constexpr

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

insert() [3/4]

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

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

constexpr

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<std::integral T, null_count_policy NCP = tracking_null_count<>>

iterator sparrow::dynamic_bitset_base< buffer< T > *, NCP >::insert ( const_iterator pos, value_type value )

constexpr

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

operator=() [1/2]

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

non_owning_dynamic_bitset & sparrow::non_owning_dynamic_bitset< T, NCP >::operator= ( const non_owning_dynamic_bitset< T, NCP > & )

constexprdefault

operator=() [2/2]

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

non_owning_dynamic_bitset & sparrow::non_owning_dynamic_bitset< T, NCP >::operator= ( non_owning_dynamic_bitset< T, NCP > && )

constexprdefaultnoexcept

pop_back()

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

void sparrow::dynamic_bitset_base< buffer< T > *, NCP >::pop_back ( )

constexpr

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

push_back()

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

void sparrow::dynamic_bitset_base< buffer< T > *, NCP >::push_back ( value_type value )

constexpr

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

resize()

template<std::integral T, null_count_policy NCP = tracking_null_count<>>

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

constexpr

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

---

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

• sparrow/buffer/dynamic_bitset/non_owning_dynamic_bitset.hpp