Description:

template<typename TInterface, TInterface TEnd, TInterface TBegin = 0>
template<typename TBitSetCM, bool isReverse>
class alib::lang::TBitSet< TInterface, TEnd, TBegin >::TBidiIterator< TBitSetCM, isReverse >

Implementation of std::iterator_traits for class TBitSet. As the name of the class indicates, this iterator satisfies the C++ standard library concept of bidirectional iterators. The template parameters allow this type to act as a const or mutable as well as a forward or backward iterator.
The public available type definitions which specify the template parameters and are returned from the various begin() and end() variants of the outer class are:

Template Parameters

TBitSetCM	A constant or mutable TBitSet.
isReverse	If set, this iterator is a swaps ++ and – operators.

Definition at line 635 of file bitset.hpp.

#include <bitset.hpp>

Public Type Index:
using	difference_type = int
	Implementation of `std::iterator_traits`.

using	iterator_category = std::bidirectional_iterator_tag
	Implementation of `std::iterator_traits`.

using	pointer = void
	Implementation of `std::iterator_traits`.

using	reference = Reference<TBitSetCM>&
	Implementation of `std::iterator_traits`.

using	value_type = TInterface
	Implementation of `std::iterator_traits`.

Public Method Index:
	TBidiIterator (TBitSetCM &bitSet, TInterface startBit)

bool	operator!= (const TBidiIterator &other) const

reference	operator* ()

TBidiIterator &	operator++ ()

TBidiIterator	operator++ (int)

TBidiIterator &	operator-- ()

TBidiIterator	operator-- (int)

bool	operator< (TBidiIterator other) const

bool	operator<= (TBidiIterator other) const

bool	operator== (const TBidiIterator &other) const

bool	operator> (TBidiIterator other) const

bool	operator>= (TBidiIterator other) const

Protected Field Index:
Reference< TBitSetCM >	ref

Protected Method Index:
TBidiIterator &	down ()

TBidiIterator &	up ()

Type Definition Details:

◆ difference_type

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

template<typename TBitSetCM , bool isReverse>

using difference_type = int

Implementation of std::iterator_traits.

Definition at line 640 of file bitset.hpp.

◆ iterator_category

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

template<typename TBitSetCM , bool isReverse>

using iterator_category = std::bidirectional_iterator_tag

Implementation of std::iterator_traits.

Definition at line 638 of file bitset.hpp.

◆ pointer

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

template<typename TBitSetCM , bool isReverse>

using pointer = void

Implementation of std::iterator_traits.

Definition at line 641 of file bitset.hpp.

◆ reference

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

template<typename TBitSetCM , bool isReverse>

using reference = Reference<TBitSetCM>&

Implementation of std::iterator_traits.

Definition at line 642 of file bitset.hpp.

◆ value_type

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

template<typename TBitSetCM , bool isReverse>

using value_type = TInterface

Implementation of std::iterator_traits.

Definition at line 639 of file bitset.hpp.

Field Details:

◆ ref

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

template<typename TBitSetCM , bool isReverse>

Reference<TBitSetCM> ref

protected

The bit this iterator currently addresses. This is true for forward and reverse iterators. (Because this is not using the std::reverse_iterator< which would implement an reverse iterator that points 'before' the current element.

Definition at line 648 of file bitset.hpp.

Constructor(s) / Destructor Details:

◆ TBidiIterator()

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

template<typename TBitSetCM , bool isReverse>

TBidiIterator	(	TBitSetCM &	bitSet,
		TInterface	startBit )

inlineexplicit

Constructor.

Parameters

bitSet	The bit set to use.
startBit	The bit number to start with.

Definition at line 724 of file bitset.hpp.

Method Details:

◆ down()

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

template<typename TBitSetCM , bool isReverse>

TBidiIterator & down ( )

inlineprotected

Searches and moves this iterator to the next lower bit is. In case no lower bit is found, the iterator will points to illegal bit number -1.

Returns: A reference to this object.

Definition at line 686 of file bitset.hpp.

Here is the call graph for this function:

◆ operator!=()

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

template<typename TBitSetCM , bool isReverse>

bool operator!= ( const TBidiIterator< TBitSetCM, isReverse > & other ) const

inline

Comparison operator.

Parameters

other The iterator to compare ourselves to.

Returns: true if this and given iterator are not equal, false otherwise.

Definition at line 758 of file bitset.hpp.

◆ operator*()

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

template<typename TBitSetCM , bool isReverse>

reference operator* ( )

inline

Retrieves a reference to the internal Reference member that this iterator uses.

Returns: The reference to the bit this iterator is currently addressing.

Definition at line 766 of file bitset.hpp.

◆ operator++() [1/2]

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

template<typename TBitSetCM , bool isReverse>

TBidiIterator & operator++ ( )

inline

Prefix increment operator.

Returns: A reference to this object.

Definition at line 731 of file bitset.hpp.

Here is the call graph for this function:

◆ operator++() [2/2]

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

template<typename TBitSetCM , bool isReverse>

TBidiIterator operator++ ( int )

inline

Postfix increment operator.

Returns: An iterator value that is not increased, yet.

Definition at line 739 of file bitset.hpp.

◆ operator--() [1/2]

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

template<typename TBitSetCM , bool isReverse>

TBidiIterator & operator-- ( )

inline

Prefix decrement operator.

Returns: A reference to this object.

Definition at line 774 of file bitset.hpp.

Here is the call graph for this function:

◆ operator--() [2/2]

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

template<typename TBitSetCM , bool isReverse>

TBidiIterator operator-- ( int )

inline

Postfix decrement operator.

Returns: The iterator value prior the decrement operation.

Definition at line 782 of file bitset.hpp.

◆ operator<()

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

template<typename TBitSetCM , bool isReverse>

bool operator< ( TBidiIterator< TBitSetCM, isReverse > other ) const

inline

Compares this iterator with the given one.

Parameters

other The iterator to compare

Returns: true if this iterator is smaller than other, false otherwise.

Definition at line 794 of file bitset.hpp.

◆ operator<=()

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

template<typename TBitSetCM , bool isReverse>

bool operator<= ( TBidiIterator< TBitSetCM, isReverse > other ) const

inline

Compares this iterator with the given one.

Parameters

other The iterator to compare

Returns: true if this iterator is smaller than or equal to other, false otherwise.

Definition at line 801 of file bitset.hpp.

◆ operator==()

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

template<typename TBitSetCM , bool isReverse>

bool operator== ( const TBidiIterator< TBitSetCM, isReverse > & other ) const

inline

Comparison operator.

Parameters

other The iterator to compare ourselves to.

Returns: true if this and the given iterator are pointing to the same bit in the same set, false otherwise.

Definition at line 750 of file bitset.hpp.

◆ operator>()

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

template<typename TBitSetCM , bool isReverse>

bool operator> ( TBidiIterator< TBitSetCM, isReverse > other ) const

inline

Compares this iterator with the given one.

Parameters

other The iterator to compare

Returns: true if this iterator is greater than other, false otherwise.

Definition at line 808 of file bitset.hpp.

◆ operator>=()

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

template<typename TBitSetCM , bool isReverse>

bool operator>= ( TBidiIterator< TBitSetCM, isReverse > other ) const

inline

Compares this iterator with the given one.

Parameters

other The iterator to compare

Returns: true if this iterator is greater than or equal to other, false otherwise.

Definition at line 815 of file bitset.hpp.

◆ up()

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

template<typename TBitSetCM , bool isReverse>

TBidiIterator & up ( )

inlineprotected

Searches and moves this iterator to the next higher bit is. In case no further bit is found, the iterator will points to illegal bit number TBitSet::Capacity

Returns: A reference to this object.

Definition at line 653 of file bitset.hpp.

Here is the call graph for this function:

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

bitset.hpp

Description:

Public Type Index:

Public Method Index:

Protected Field Index:

Protected Method Index:

Type Definition Details:

◆ difference_type

◆ iterator_category

◆ pointer

◆ reference

◆ value_type

Field Details:

◆ ref

Constructor(s) / Destructor Details:

◆ TBidiIterator()

Method Details:

◆ down()

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ up()