Description:

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>
class alib::lang::TBitSet< TInterface, TEnd, TBegin >

This class is an improved replica of std::bitset and hence stores and exposes a set of bits. The differences (advantages) of this class to the standard type are:

The class provides an efficient bidirectional iterator, which uses intrinsics (on supported platforms, via functions CLZ and CTZ) to search the next bit set without looping over unset bits.
The size of this type's instances is adjusted to the next fitting integral size, namely char, short, int, long and long long. If even larger bitsets are requested, the size becomes a multiple of the size of long long.
The type that denotes bit-indices, which is used in the interface methods, can optionally be altered from int to a custom type which is statically castable to int, by providing the defaulted template parameter TInterface accordingly. This avoids the need for statically casting the index type with every invocation of an interface method.
The main motivation for providing this was to allow to address bits with enumeration elements.
Instead of one template parameter defining the fixed size of the bitset, two parameters TBegin and TEnd are provided. This allows defining bitsets of a range of indices that do not start with 0 and in this case avoids the need for subtraction of the (fixed) start value of a range with every invocation of an interface method.
Methods Set and Reset allow to pass several bit indices at once using a comma-separated list.
With methods std::bitset<N>::to_ulong() / to_ullong(), the standard type allows the export of the internal value only to 64-bit values (on common platforms). If the higher bits are to be exported, the bitset has to be shifted, which is inefficient and destructive (a copy has to be taken).
This implementation provides method Export, which - dependent on the size of the bitset - offers an additional index to address any higher word. Furthermore, for smaller bitsets the export method returns a fitting smaller integral.
Explicit uninitialized construction is possíble with TBitSet::TBitSet(const std::nullptr_t&), which avoids code and run-time penalty, in cases where the bits are to be initialized at a later stage.

In respect to performance, this type equals a typical implementation std::bitset.

See also

Type definition EnumBitSet, which defines a bitset over ALib Iterable Enums based on this type.
For a quick tutorial on the use of this type (in nice combination with C++ enumerations), see chapter 3.5 Using Class TBitSet with Iterable Enums of the Programmer's Manual of module ALib EnumOps.
Type definition BitSet in namespace alib, which defines a set with interface-type int.
Class BitBuffer, which implements a sort of stream buffer to store bits in dynamic memory.

Template Parameters

TInterface	The interface type to denote bit position values. This type has to be statically castable to and constructible from `int`.
TEnd	The last index of the interface type plus `1`.
TBegin	The first index of the interface type. (Defaults to `0`.)

Definition at line 63 of file bitset.inl.

Inner Type Index:
class	Reference

class	TBidiIterator

Public Type Index:
using	ConstIterator = TBidiIterator<const TBitSet, false>
	The constant iterator type.

using	ConstReverseIterator = TBidiIterator<const TBitSet, true>
	Same as ConstIterator, but working from the end to the start of the TBitSet.

using	Iterator = TBidiIterator<TBitSet, false>

using	ReverseIterator = TBidiIterator<TBitSet, true>
	Same as Iterator, but working from the end to the start of the TBitSet.

using	TWord

Public Static Field Index:
static constexpr int	Capacity

static constexpr int	QtyWords
	The size of the TWord array containing the bits.

Public Method Index:
constexpr	TBitSet () noexcept
	Default constructor initializing all bits to not set.

constexpr	TBitSet (bool preset) noexcept

constexpr	TBitSet (const std::nullptr_t &) noexcept

constexpr	TBitSet (TWord preset) noexcept

constexpr bool	All () const noexcept

constexpr bool	Any () const noexcept

Iterator	begin (int skip=0)

ConstIterator	begin (int skip=0) const

ConstIterator	cbegin (int skip=0) const

ConstIterator	cend () const

constexpr int	Count () const noexcept

ConstReverseIterator	crbegin (int skip=0) const

ConstReverseIterator	crend () const

Iterator	end ()

ConstIterator	end () const

constexpr const TWord &	Export (int wordIdx) const noexcept

constexpr TWord &	Export (int wordIdx) noexcept

constexpr TBitSet &	Flip () noexcept
	Flips all bits from `0` to `1` and vice versa.

template<typename... T>
constexpr TBitSet &	Flip (TInterface firstBit, T &&... furtherBits) noexcept

constexpr void	Import (TWord val, int wordIdx) noexcept

constexpr bool	None () const noexcept

constexpr TBitSet &	operator&= (const TBitSet &rhs) noexcept

constexpr TBitSet	operator<< (int cnt) const noexcept

constexpr TBitSet &	operator<<= (int cnt) noexcept

constexpr bool	operator== (const TBitSet &rhs) const noexcept

constexpr TBitSet	operator>> (int cnt) const noexcept

constexpr TBitSet &	operator>>= (int cnt) noexcept

constexpr const Reference< const TBitSet >	operator[] (int bit) const noexcept

constexpr Reference< TBitSet >	operator[] (TInterface bit) noexcept

constexpr TBitSet &	operator^= (const TBitSet &rhs) noexcept

constexpr TBitSet &	operator\|= (const TBitSet &rhs) noexcept

constexpr TBitSet	operator~ () const noexcept

ReverseIterator	rbegin (int skip=0)

ConstReverseIterator	rbegin (int skip=0) const

ReverseIterator	rend ()

ConstReverseIterator	rend () const

constexpr TBitSet &	Reset () noexcept
	Sets all bits to `0`.

template<typename... T>
constexpr TBitSet &	Reset (TInterface firstBit, T &&... furtherBits) noexcept

constexpr TBitSet &	Set () noexcept
	Sets all bits to `1`.

template<typename... T>
constexpr TBitSet &	Set (TInterface bit, bool val) noexcept

template<typename... T>
constexpr TBitSet &	Set (TInterface firstBit, T &&... furtherBits) noexcept

constexpr bool	Test (TInterface bit) noexcept

Protected Static Method Index:
static constexpr int	bitIdx (TInterface b) noexcept

static constexpr TWord	mask (int wIdx) noexcept

static constexpr TWord	mask0010 (TInterface b) noexcept

static constexpr TWord	mask1101 (TInterface b) noexcept

static constexpr int	wordIdx (TInterface b) noexcept

Protected Field Index:
TWord	words [QtyWords ? QtyWords :1]

Protected Method Index:
constexpr void	shiftLeft (int cnt, TBitSet &target) const noexcept

constexpr void	shiftRight (int cnt, TBitSet &target) const noexcept

constexpr const TWord &	word (TInterface b) const noexcept

constexpr TWord &	word (TInterface b) noexcept

Type Definition Details:

◆ ConstIterator

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

using alib::lang::TBitSet< TInterface, TEnd, TBegin >::ConstIterator = TBidiIterator<const TBitSet, false>

The constant iterator type.

Definition at line 737 of file bitset.inl.

◆ ConstReverseIterator

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

using alib::lang::TBitSet< TInterface, TEnd, TBegin >::ConstReverseIterator = TBidiIterator<const TBitSet, true>

Same as ConstIterator, but working from the end to the start of the TBitSet.

Definition at line 740 of file bitset.inl.

◆ Iterator

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

using alib::lang::TBitSet< TInterface, TEnd, TBegin >::Iterator = TBidiIterator<TBitSet, false>

Iterator type, implementing the standard library concept of RandomAccessIterator .

Definition at line 731 of file bitset.inl.

◆ ReverseIterator

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

using alib::lang::TBitSet< TInterface, TEnd, TBegin >::ReverseIterator = TBidiIterator<TBitSet, true>

Same as Iterator, but working from the end to the start of the TBitSet.

Definition at line 734 of file bitset.inl.

◆ TWord

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

using alib::lang::TBitSet< TInterface, TEnd, TBegin >::TWord

Initial value:

 std::conditional_t< (Capacity >  bitsof(long)    ),  unsigned long long,
                 std::conditional_t< (Capacity >  bitsof(int)     ),  unsigned long     ,
                 std::conditional_t< (Capacity >  bitsof(short)   ),  unsigned int      ,
                 std::conditional_t< (Capacity >  bitsof(char)    ),  unsigned short    ,
                                                                      unsigned char      >>>>

The type that is used to store the bits in. Template programming code chooses the smallest fitting integral. If Capacity exceeds the type long long, an array of long long, field QtyWords will become greater than 1.

Definition at line 84 of file bitset.inl.

Field Details:

◆ Capacity

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

int alib::lang::TBitSet< TInterface, TEnd, TBegin >::Capacity

staticconstexpr

Initial value:

= int( TEnd )

- int( TBegin )

The number of bits in the range resulting from template parameters TBegin and TEnd.

Definition at line 77 of file bitset.inl.

◆ QtyWords

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

int alib::lang::TBitSet< TInterface, TEnd, TBegin >::QtyWords

staticconstexpr

Initial value:

= Capacity / bitsof(TWord)

+ ( (Capacity % bitsof(TWord)) != 0 ? 1 : 0 )

alib::lang::TBitSet::TWord

std::conditional_t<(Capacity > bitsof(long)), unsigned long long, std::conditional_t<(Capacity > bitsof(int)), unsigned long, std::conditional_t<(Capacity > bitsof(short)), unsigned int, std::conditional_t<(Capacity > bitsof(char)), unsigned short, unsigned char > > > > TWord

Definition bitset.inl:84

The size of the TWord array containing the bits.

Definition at line 91 of file bitset.inl.

◆ words

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TWord alib::lang::TBitSet< TInterface, TEnd, TBegin >::words[QtyWords ? QtyWords :1]

protected

The array of integrals containing the bits needed. The unused upper bits in the last word are always kept 0.

Definition at line 97 of file bitset.inl.

Constructor(s) / Destructor Details:

◆ TBitSet() [1/4]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

alib::lang::TBitSet< TInterface, TEnd, TBegin >::TBitSet ( )

inlineconstexprnoexcept

Default constructor initializing all bits to not set.

Definition at line 223 of file bitset.inl.

◆ TBitSet() [2/4]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

alib::lang::TBitSet< TInterface, TEnd, TBegin >::TBitSet ( const std::nullptr_t & )

inlineconstexprnoexcept

Constructor taking a tag-type. This constructor omits any value initialization and has to be called by providing nullptr as the argument.

Definition at line 228 of file bitset.inl.

◆ TBitSet() [3/4]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

alib::lang::TBitSet< TInterface, TEnd, TBegin >::TBitSet ( TWord preset )

inlineconstexprnoexcept

Constructor which takes an external TWord which initializes the first word. If constexpr field QtyWords is greater than 1, the other bits are set to 0 and can be set using method Import or of course using other interface methods.

Parameters

preset The preset value for the bits.

Definition at line 234 of file bitset.inl.

◆ TBitSet() [4/4]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

alib::lang::TBitSet< TInterface, TEnd, TBegin >::TBitSet ( bool preset )

inlineconstexprnoexcept

Constructor which takes an external TWord which initializes the first word. If constexpr field QtyWords is greater than 1, the other bits are set to 0 and can be set using method Import or of course using other interface methods.

Parameters

preset The preset value for the bits.

Definition at line 244 of file bitset.inl.

Method Details:

◆ All()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

bool alib::lang::TBitSet< TInterface, TEnd, TBegin >::All ( ) const

inlineconstexprnoexcept

Tests if any bit is set.

Returns: true if all bits are set, false otherwise.

Definition at line 332 of file bitset.inl.

◆ Any()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

bool alib::lang::TBitSet< TInterface, TEnd, TBegin >::Any ( ) const

inlineconstexprnoexcept

Tests if any bit is set.

Returns: true if at least one bit is set, false otherwise.

Definition at line 342 of file bitset.inl.

◆ begin() [1/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

Iterator alib::lang::TBitSet< TInterface, TEnd, TBegin >::begin ( int skip = 0 )

inline

Returns an iterator pointing to the first (lowest) bit set.

Parameters

skip	Defaults to `0`. If set, denotes the amount of bits which are not examined at the beginning of the iteration. Must not be negative.

Returns: The start iterator. In case no bit is set, the same as end.

Definition at line 746 of file bitset.inl.

◆ begin() [2/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

ConstIterator alib::lang::TBitSet< TInterface, TEnd, TBegin >::begin ( int skip = 0 ) const

inline

Returns a const iterator pointing to the first (lowest) bit set.

Parameters

skip	Defaults to `0`. If set, denotes the amount of bits which are not examined at the beginning of the iteration. Must not be negative.

Returns: The start iterator. In case no bit is set, the same as end.

Definition at line 768 of file bitset.inl.

◆ bitIdx()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

constexpr int alib::lang::TBitSet< TInterface, TEnd, TBegin >::bitIdx ( TInterface b )

inlinestaticconstexprprotectednoexcept

Helper to determine the bit index in the actual word.

Parameters

b	The absolute index.

Returns: The relative index.

Definition at line 109 of file bitset.inl.

◆ cbegin()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

ConstIterator alib::lang::TBitSet< TInterface, TEnd, TBegin >::cbegin ( int skip = 0 ) const

inline

Returns a const iterator pointing to the first (lowest) bit set.

Parameters

skip	Defaults to `0`. If set, denotes the amount of bits which are not examined at the beginning of the iteration. Must not be negative.

Returns: The start iterator. In case no bit is set, the same as end.

Definition at line 775 of file bitset.inl.

◆ cend()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

ConstIterator alib::lang::TBitSet< TInterface, TEnd, TBegin >::cend ( ) const

inline

Returns a const iterator pointing to the non-existing bit behind the highest one.

Returns: The end iterator.

Definition at line 784 of file bitset.inl.

◆ Count()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

int alib::lang::TBitSet< TInterface, TEnd, TBegin >::Count ( ) const

inlineconstexprnoexcept

Returns the number of bits set to true in this set.

Returns: The number of bits counted.

Definition at line 322 of file bitset.inl.

◆ crbegin()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

ConstReverseIterator alib::lang::TBitSet< TInterface, TEnd, TBegin >::crbegin ( int skip = 0 ) const

inline

Returns a const reverse iterator pointing to the last (highest) bit set.

Parameters

skip	Defaults to `0`. If set, denotes the amount of bits which are not examined at the beginning of the iteration. Must not be negative.

Returns: The reverse iteration start.

Definition at line 801 of file bitset.inl.

◆ crend()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

ConstReverseIterator alib::lang::TBitSet< TInterface, TEnd, TBegin >::crend ( ) const

inline

Returns a const iterator pointing to the non-existing bit before the lowest one.

Returns: The reverse iteratation end.

Definition at line 806 of file bitset.inl.

◆ end() [1/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

Iterator alib::lang::TBitSet< TInterface, TEnd, TBegin >::end ( )

inline

Returns an iterator pointing to the non-existing bit behind the highest one.

Returns: The end iterator.

Definition at line 751 of file bitset.inl.

◆ end() [2/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

ConstIterator alib::lang::TBitSet< TInterface, TEnd, TBegin >::end ( ) const

inline

Returns a const iterator pointing to the non-existing bit behind the highest one.

Returns: The end iterator.

Definition at line 780 of file bitset.inl.

◆ Export() [1/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

const TWord & alib::lang::TBitSet< TInterface, TEnd, TBegin >::Export ( int wordIdx ) const

inlineconstexprnoexcept

Const version of Export.

Parameters

wordIdx The subset of bits to receive.
ATTENTION: See non-constant variant Export on this parameter!

Returns: A reference to the inner word.

Definition at line 378 of file bitset.inl.

◆ Export() [2/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TWord & alib::lang::TBitSet< TInterface, TEnd, TBegin >::Export ( int wordIdx )

inlineconstexprnoexcept

Exports the internal integral(s) holding the bits.

Attention: Other than this documentation suggests, parameter wordIdx is only available if the bitset size (defined by template parameters TBegin and TEnd) exceeds the number of bits in the widest possible TWord-type, hence the size of sizeof(long long) * 8. In that case, field QtyWords provides the number of words that are exportable.
This maximum word size is 64-bit on common platforms. Here, 0 adresses bits 0..63, 1 bits 64..127 and so forth.

Parameters

wordIdx The subset of bits to receive. (See note above!)

Returns: A reference to the inner word.

Definition at line 370 of file bitset.inl.

◆ Flip() [1/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TBitSet & alib::lang::TBitSet< TInterface, TEnd, TBegin >::Flip ( )

inlineconstexprnoexcept

Flips all bits from 0 to 1 and vice versa.

Returns: A reference to this object.

Definition at line 309 of file bitset.inl.

◆ Flip() [2/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

template<typename... T>

TBitSet & alib::lang::TBitSet< TInterface, TEnd, TBegin >::Flip	(	TInterface	firstBit,
		T &&...	furtherBits )

inlineconstexprnoexcept

Flips one or more bits from 0 to 1 and vice versa.

Parameters

firstBit	The index of the bit to flip.
furtherBits	An optional continued list of indices of bits to flip.

Returns: A reference to this object.

Definition at line 296 of file bitset.inl.

◆ Import()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

void alib::lang::TBitSet< TInterface, TEnd, TBegin >::Import	(	TWord	val,
		int	wordIdx )

inlineconstexprnoexcept

Imports the data from (a) given integral(s).

Attention: Other than this documentation suggests, parameter wordIdx is only available if the bitset size (defined by template parameters TBegin and TEnd) exceeds the number of bits in the widest possible TWord-type, hence the size of sizeof(long long) * 8. In that case, field QtyWords provides the number of words that are importable.
This maximum word size is 64-bit on common platforms. Here, 0 address bits 0..63, 1 bits 64..127 and so forth.

Parameters

val	The value to import.
wordIdx	The subset of bits to overwrite. (See note above!)

Definition at line 406 of file bitset.inl.

◆ mask()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

constexpr TWord alib::lang::TBitSet< TInterface, TEnd, TBegin >::mask ( int wIdx )

inlinestaticconstexprprotectednoexcept

Returns a bitmask with all used bits set.

Parameters

wIdx	The index of the word in array words.

Returns: A bitmask with all bits set for indices smaller than QtyWords -1, and a mask that covers the remaining bits if wIdx targets the last word.

Definition at line 131 of file bitset.inl.

◆ mask0010()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

constexpr TWord alib::lang::TBitSet< TInterface, TEnd, TBegin >::mask0010 ( TInterface b )

inlinestaticconstexprprotectednoexcept

Returns a bitmask with only the given bit set.

Parameters

b	The index of the bit to set.

Returns: A bitmask with one bit set.

Definition at line 140 of file bitset.inl.

◆ mask1101()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

constexpr TWord alib::lang::TBitSet< TInterface, TEnd, TBegin >::mask1101 ( TInterface b )

inlinestaticconstexprprotectednoexcept

Returns a bitmask with only the given bit unset.

Parameters

b	The index of the bit to unset.

Returns: A bitmask with all but one bit set.

Definition at line 145 of file bitset.inl.

◆ None()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

bool alib::lang::TBitSet< TInterface, TEnd, TBegin >::None ( ) const

inlineconstexprnoexcept

Tests if not any bit is set.

Returns: false if at least one bit is set, true otherwise.

Definition at line 352 of file bitset.inl.

◆ operator&=()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TBitSet & alib::lang::TBitSet< TInterface, TEnd, TBegin >::operator&= ( const TBitSet< TInterface, TEnd, TBegin > & rhs )

inlineconstexprnoexcept

Sets the bits to the result of binary AND on corresponding pairs of bits of this and other.

Parameters

rhs	The other TBitSet to compare this with.

Returns: A reference to this object.

Definition at line 436 of file bitset.inl.

◆ operator<<()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TBitSet alib::lang::TBitSet< TInterface, TEnd, TBegin >::operator<< ( int cnt ) const

inlineconstexprnoexcept

Returns a temporary copy of this with a shift to the left (towards higher index positions).

Parameters

cnt	The number of positions to shift.

Returns: A copy of this with shifted bits.

Definition at line 524 of file bitset.inl.

◆ operator<<=()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TBitSet & alib::lang::TBitSet< TInterface, TEnd, TBegin >::operator<<= ( int cnt )

inlineconstexprnoexcept

Shifts the bits of this object to the left (towards higher index positions).

Parameters

cnt	The number of positions to shift.

Returns: A reference to this object.

Definition at line 530 of file bitset.inl.

◆ operator==()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

bool alib::lang::TBitSet< TInterface, TEnd, TBegin >::operator== ( const TBitSet< TInterface, TEnd, TBegin > & rhs ) const

inlineconstexprnoexcept

Compares this bitset with another bitset of equal size.

Parameters

rhs	The other TBitSet to compare this with.

Returns: true if all bits are equal, false otherwise.

Definition at line 426 of file bitset.inl.

◆ operator>>()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TBitSet alib::lang::TBitSet< TInterface, TEnd, TBegin >::operator>> ( int cnt ) const

inlineconstexprnoexcept

Returns a temporary copy of this with a shift to the right (towards lower index positions).

Parameters

cnt	The number of positions to shift.

Returns: A copy of this with shifted bits.

Definition at line 535 of file bitset.inl.

◆ operator>>=()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TBitSet & alib::lang::TBitSet< TInterface, TEnd, TBegin >::operator>>= ( int cnt )

inlineconstexprnoexcept

Shifts the bits of this object to the left right (towards lower index positions).

Parameters

cnt	The number of positions to shift.

Returns: A reference to this object.

Definition at line 541 of file bitset.inl.

◆ operator[]() [1/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

const Reference< const TBitSet > alib::lang::TBitSet< TInterface, TEnd, TBegin >::operator[] ( int bit ) const

inlineconstexprnoexcept

Returns a const reference to a specific bit.

Parameters

bit	The bit to create a reference for.

Returns: A reference to the bit in this object.

Definition at line 554 of file bitset.inl.

◆ operator[]() [2/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

Reference< TBitSet > alib::lang::TBitSet< TInterface, TEnd, TBegin >::operator[] ( TInterface bit )

inlineconstexprnoexcept

Returns a reference to a specific bit.

Parameters

bit	The bit to create a reference for.

Returns: A reference to the bit in this object.

Definition at line 547 of file bitset.inl.

◆ operator^=()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TBitSet & alib::lang::TBitSet< TInterface, TEnd, TBegin >::operator^= ( const TBitSet< TInterface, TEnd, TBegin > & rhs )

inlineconstexprnoexcept

Sets the bits to the result of binary XOR on corresponding pairs of bits of this and other.

Parameters

rhs	The other TBitSet to compare this with.

Returns: A reference to this object.

Definition at line 446 of file bitset.inl.

◆ operator|=()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TBitSet & alib::lang::TBitSet< TInterface, TEnd, TBegin >::operator|= ( const TBitSet< TInterface, TEnd, TBegin > & rhs )

inlineconstexprnoexcept

Sets the bits to the result of binary OR on corresponding pairs of bits of this and other.

Parameters

rhs	The other TBitSet to compare this with.

Returns: A reference to this object.

Definition at line 441 of file bitset.inl.

◆ operator~()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TBitSet alib::lang::TBitSet< TInterface, TEnd, TBegin >::operator~ ( ) const

inlineconstexprnoexcept

Returns a temporary copy of this with all bits flipped (binary NOT)..

Returns: A copy of this with flipped bits.

Definition at line 450 of file bitset.inl.

◆ rbegin() [1/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

ReverseIterator alib::lang::TBitSet< TInterface, TEnd, TBegin >::rbegin ( int skip = 0 )

inline

Returns a reverse iterator pointing to the last (highest) bit set.

Parameters

skip	Defaults to `0`. If set, denotes the amount of bits which are not examined at the beginning of the iteration. Must not be negative.

Returns: The reverse iteration start.

Definition at line 757 of file bitset.inl.

◆ rbegin() [2/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

ConstReverseIterator alib::lang::TBitSet< TInterface, TEnd, TBegin >::rbegin ( int skip = 0 ) const

inline

Returns a const reverse iterator pointing to the last (highest) bit set.

Parameters

skip	Defaults to `0`. If set, denotes the amount of bits which are not examined at the beginning of the iteration. Must not be negative.

Returns: The reverse iteration start.

Definition at line 790 of file bitset.inl.

◆ rend() [1/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

ReverseIterator alib::lang::TBitSet< TInterface, TEnd, TBegin >::rend ( )

inline

Returns an iterator pointing to the non-existing bit before the lowest one.

Returns: The reverse iteratation end.

Definition at line 762 of file bitset.inl.

◆ rend() [2/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

ConstReverseIterator alib::lang::TBitSet< TInterface, TEnd, TBegin >::rend ( ) const

inline

Returns a const iterator pointing to the non-existing bit before the lowest one.

Returns: The reverse iteratation end.

Definition at line 795 of file bitset.inl.

◆ Reset() [1/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TBitSet & alib::lang::TBitSet< TInterface, TEnd, TBegin >::Reset ( )

inlineconstexprnoexcept

Sets all bits to 0.

Returns: A reference to this object.

Definition at line 307 of file bitset.inl.

◆ Reset() [2/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

template<typename... T>

TBitSet & alib::lang::TBitSet< TInterface, TEnd, TBegin >::Reset	(	TInterface	firstBit,
		T &&...	furtherBits )

inlineconstexprnoexcept

Sets one or more bits to 0.

Parameters

firstBit	The index of the first bit to clear.
furtherBits	An optional continued list of bit-indices.

Returns: A reference to this object.

Definition at line 283 of file bitset.inl.

◆ Set() [1/3]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TBitSet & alib::lang::TBitSet< TInterface, TEnd, TBegin >::Set ( )

inlineconstexprnoexcept

Sets all bits to 1.

Returns: A reference to this object.

Definition at line 305 of file bitset.inl.

◆ Set() [2/3]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

template<typename... T>

TBitSet & alib::lang::TBitSet< TInterface, TEnd, TBegin >::Set	(	TInterface	bit,
		bool	val )

inlineconstexprnoexcept

Sets the bit to 1.

Parameters

bit	The index of the bit to set.
val	`true` or `false` to set or clear bit bit.

Returns: A reference to this object.

Definition at line 258 of file bitset.inl.

◆ Set() [3/3]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

template<typename... T>

TBitSet & alib::lang::TBitSet< TInterface, TEnd, TBegin >::Set	(	TInterface	firstBit,
		T &&...	furtherBits )

inlineconstexprnoexcept

Sets one or more bits to 1.

Parameters

firstBit	The index of the first bit to set.
furtherBits	An optional continued list of bit-indices.

Returns: A reference to this object.

Definition at line 270 of file bitset.inl.

◆ shiftLeft()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

void alib::lang::TBitSet< TInterface, TEnd, TBegin >::shiftLeft	(	int	cnt,
		TBitSet< TInterface, TEnd, TBegin > &	target ) const

inlineconstexprprotectednoexcept

Stores a shifted result in target. This protected method is accessible via operator<<() (which creates and returns a temporary target) and operator<<=(), which passes this to parameter target.

Parameters

cnt	The number of positions to shift.
target	The target object.

Definition at line 463 of file bitset.inl.

◆ shiftRight()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

void alib::lang::TBitSet< TInterface, TEnd, TBegin >::shiftRight	(	int	cnt,
		TBitSet< TInterface, TEnd, TBegin > &	target ) const

inlineconstexprprotectednoexcept

Stores a shifted result in target. This protected method is accessible via operator>>() (which creates and returns a temporary target) and operator>>=(), which passes this to parameter target.

Parameters

cnt	The number of positions to shift.
target	The target object.

Definition at line 494 of file bitset.inl.

◆ Test()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

bool alib::lang::TBitSet< TInterface, TEnd, TBegin >::Test ( TInterface bit )

inlineconstexprnoexcept

Returns true if the bit is set, false otherwise.

Parameters

bit	Denotes the bit to test.

Returns: The state of the bit.

Definition at line 316 of file bitset.inl.

◆ word() [1/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

const TWord & alib::lang::TBitSet< TInterface, TEnd, TBegin >::word ( TInterface b ) const

inlineconstexprprotectednoexcept

Helper receive a const reference word from the array of words.

Parameters

b	The bit to address index.

Returns: A reference to the word.

Definition at line 125 of file bitset.inl.

◆ word() [2/2]

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

TWord & alib::lang::TBitSet< TInterface, TEnd, TBegin >::word ( TInterface b )

inlineconstexprprotectednoexcept

Helper receive the word from the array of words.

Parameters

b	The bit to address index.

Returns: A reference to the word.

Definition at line 120 of file bitset.inl.

◆ wordIdx()

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>

constexpr int alib::lang::TBitSet< TInterface, TEnd, TBegin >::wordIdx ( TInterface b )

inlinestaticconstexprprotectednoexcept

Helper to determine the bit index in the actual word.

Parameters

b	The absolute index.

Returns: The word index.

Definition at line 103 of file bitset.inl.

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

bitset.inl

Description:

Inner Type Index:

Public Type Index:

Public Static Field Index:

Public Method Index:

Protected Static Method Index:

Protected Field Index:

Protected Method Index:

Type Definition Details:

◆ ConstIterator

◆ ConstReverseIterator

◆ Iterator

◆ ReverseIterator

◆ TWord

Field Details:

◆ Capacity

◆ QtyWords

◆ words

Constructor(s) / Destructor Details:

◆ TBitSet() [1/4]

◆ TBitSet() [2/4]

◆ TBitSet() [3/4]

◆ TBitSet() [4/4]

Method Details:

◆ All()

◆ Any()

◆ begin() [1/2]

◆ begin() [2/2]

◆ bitIdx()

◆ cbegin()

◆ cend()

◆ Count()

◆ crbegin()

◆ crend()

◆ end() [1/2]

◆ end() [2/2]

◆ Export() [1/2]

◆ Export() [2/2]

◆ Flip() [1/2]

◆ Flip() [2/2]

◆ Import()

◆ mask()

◆ mask0010()

◆ mask1101()

◆ None()

◆ operator&=()

◆ operator<<()

◆ operator<<=()

◆ operator==()

◆ operator>>()

◆ operator>>=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator^=()

◆ operator|=()

◆ operator~()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ Reset() [1/2]

◆ Reset() [2/2]

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ shiftLeft()

◆ shiftRight()

◆ Test()

◆ word() [1/2]

◆ word() [2/2]

◆ wordIdx()