Botan::detail::bitvector_iterator< T > Class Template Reference

#include <bitvector.h>

Public Types
using	difference_type = std::make_signed_t<size_type>
using	iterator_category = std::bidirectional_iterator_tag
using	pointer = value_type*
using	reference = value_type&
using	value_type = std::remove_const_t<decltype(std::declval<T>().at(0))>

Public Member Functions
	bitvector_iterator ()=default
	bitvector_iterator (bitvector_iterator &&other) noexcept
	bitvector_iterator (const bitvector_iterator &other) noexcept
	bitvector_iterator (T *bitvector, size_t offset)
reference	operator* () const
bitvector_iterator &	operator++ () noexcept
bitvector_iterator	operator++ (int) noexcept
bitvector_iterator &	operator-- () noexcept
bitvector_iterator	operator-- (int) noexcept
pointer	operator-> () const
std::partial_ordering	operator<=> (const bitvector_iterator &other) const noexcept
bitvector_iterator &	operator= (bitvector_iterator &&other) noexcept
bitvector_iterator &	operator= (const bitvector_iterator &other) noexcept
bool	operator== (const bitvector_iterator &other) const noexcept
	~bitvector_iterator ()=default

Detailed Description

template<typename T>
class Botan::detail::bitvector_iterator< T >

Definition at line 124 of file bitvector.h.

Member Typedef Documentation

difference_type

template<typename T>

using Botan::detail::bitvector_iterator< T >::difference_type = std::make_signed_t<size_type>

Definition at line 129 of file bitvector.h.

iterator_category

template<typename T>

using Botan::detail::bitvector_iterator< T >::iterator_category = std::bidirectional_iterator_tag

Definition at line 135 of file bitvector.h.

pointer

template<typename T>

using Botan::detail::bitvector_iterator< T >::pointer = value_type*

Definition at line 131 of file bitvector.h.

reference

template<typename T>

using Botan::detail::bitvector_iterator< T >::reference = value_type&

Definition at line 132 of file bitvector.h.

value_type

template<typename T>

using Botan::detail::bitvector_iterator< T >::value_type = std::remove_const_t<decltype(std::declval<T>().at(0))>

Definition at line 130 of file bitvector.h.

Constructor & Destructor Documentation

bitvector_iterator() [1/4]

template<typename T>

Botan::detail::bitvector_iterator< T >::bitvector_iterator ( )

default

~bitvector_iterator()

template<typename T>

Botan::detail::bitvector_iterator< T >::~bitvector_iterator ( )

default

bitvector_iterator() [2/4]

template<typename T>

Botan::detail::bitvector_iterator< T >::bitvector_iterator ( T * bitvector, size_t offset )

inline

Definition at line 141 of file bitvector.h.

: m_bitvector(bitvector) { update(offset); }

bitvector_iterator() [3/4]

template<typename T>

Botan::detail::bitvector_iterator< T >::bitvector_iterator ( const bitvector_iterator< T > & other )

inlinenoexcept

Definition at line 143 of file bitvector.h.

                                                                   : m_bitvector(other.m_bitvector) {
         update(other.m_offset);
      }

bitvector_iterator() [4/4]

template<typename T>

Botan::detail::bitvector_iterator< T >::bitvector_iterator ( bitvector_iterator< T > && other )

inlinenoexcept

Definition at line 147 of file bitvector.h.

                                                              : m_bitvector(other.m_bitvector) {
         update(other.m_offset);
      }

Member Function Documentation

operator*()

template<typename T>

reference Botan::detail::bitvector_iterator< T >::operator* ( ) const

inline

Definition at line 199 of file bitvector.h.

{ return m_bitref.value(); }

operator++() [1/2]

template<typename T>

bitvector_iterator & Botan::detail::bitvector_iterator< T >::operator++ ( )

inlinenoexcept

Definition at line 165 of file bitvector.h.

                                                {
         update(signed_offset() + 1);
         return *this;
      }

operator++() [2/2]

template<typename T>

bitvector_iterator Botan::detail::bitvector_iterator< T >::operator++ ( int )

inlinenoexcept

Definition at line 170 of file bitvector.h.

                                                  {
         auto copy = *this;
         update(signed_offset() + 1);
         return copy;
      }

operator--() [1/2]

template<typename T>

bitvector_iterator & Botan::detail::bitvector_iterator< T >::operator-- ( )

inlinenoexcept

Definition at line 176 of file bitvector.h.

                                                {
         update(signed_offset() - 1);
         return *this;
      }

operator--() [2/2]

template<typename T>

bitvector_iterator Botan::detail::bitvector_iterator< T >::operator-- ( int )

inlinenoexcept

Definition at line 181 of file bitvector.h.

                                                  {
         auto copy = *this;
         update(signed_offset() - 1);
         return copy;
      }

operator->()

template<typename T>

pointer Botan::detail::bitvector_iterator< T >::operator-> ( ) const

inline

Definition at line 201 of file bitvector.h.

{ return &(m_bitref.value()); }

operator<=>()

template<typename T>

std::partial_ordering Botan::detail::bitvector_iterator< T >::operator<=> ( const bitvector_iterator< T > & other ) const

inlinenoexcept

Definition at line 187 of file bitvector.h.

                                   =>(const bitvector_iterator& other) const noexcept {
         if(m_bitvector == other.m_bitvector) {
            return m_offset <=> other.m_offset;
         } else {
            return std::partial_ordering::unordered;
         }
      }

operator=() [1/2]

template<typename T>

bitvector_iterator & Botan::detail::bitvector_iterator< T >::operator= ( bitvector_iterator< T > && other )

inlinenoexcept

Definition at line 159 of file bitvector.h.

                                                                       {
         m_bitvector = other.m_bitvector;
         update(other.m_offset);
         return *this;
      }

operator=() [2/2]

template<typename T>

bitvector_iterator & Botan::detail::bitvector_iterator< T >::operator= ( const bitvector_iterator< T > & other )

inlinenoexcept

Definition at line 151 of file bitvector.h.

                                                                            {
         if(this != &other) {
            m_bitvector = other.m_bitvector;
            update(other.m_offset);
         }
         return *this;
      }

operator==()

template<typename T>

bool Botan::detail::bitvector_iterator< T >::operator== ( const bitvector_iterator< T > & other ) const

inlinenoexcept

Definition at line 195 of file bitvector.h.

                                                                    {
         return m_bitvector == other.m_bitvector && m_offset == other.m_offset;
      }

---

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

• src/lib/utils/bitvector/bitvector.h