SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator Class Reference

Provides forward/backward iteration over the keys in the base level of the SkipTrie. More...

#include <SkipTrie.hpp>

Collaboration diagram for SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator:

Public Member Functions
	Iterator (Node *node, Direction direction) noexcept
	Constructs an iterator.
Iterator &	operator++ () noexcept
	Pre-increments the iterator to the next node in its designated direction.
Iterator	operator++ (int) noexcept
	Post-increments the iterator.
const KEY_T &	operator* () const noexcept
	Dereferences the iterator to access the key of the current node.
const KEY_T *	operator-> () const noexcept
	Dereferences the iterator to access the key pointer of the current node.
bool	operator== (const Iterator &other) const noexcept
	Compares this iterator with another for equality.
bool	operator!= (const Iterator &other) const noexcept
	Compares this iterator with another for inequality.

Private Attributes
Node *	m_node
	Pointer to the current node the iterator is positioned at.
Direction	m_direction
	The direction the iterator moves upon incrementing.

Detailed Description

template<typename CHAR_T, unsigned CHAR_SIZE_BITS = sizeof(CHAR_T) * 8>
class SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator

Provides forward/backward iteration over the keys in the base level of the SkipTrie.

Allows traversal through the nodes at level 0 using standard iterator operations (++, *, ->, ==, !=). Can be constructed to move FORWARD or BACKWARD.

Definition at line 392 of file SkipTrie.hpp.

Constructor & Destructor Documentation

Iterator()

template<typename CHAR_T , unsigned CHAR_SIZE_BITS>

SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator::Iterator ( Node *  node, Direction  direction  )

noexcept

Constructs an iterator.

Parameters

node	A pointer to the starting Node for the iterator (usually a node at level 0).
direction	The direction (FORWARD or BACKWARD) the iterator will move upon incrementing.

Definition at line 483 of file SkipTrie.hpp.

    : m_node(node), m_direction(direction)
{
    // Constructor body intentionally empty
}

Member Function Documentation

operator!=()

template<typename CHAR_T , unsigned CHAR_SIZE_BITS>

bool SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator::operator!= ( const Iterator &  other ) const

noexcept

Compares this iterator with another for inequality.

Parameters

other

The iterator to compare against.

Returns

bool True if the iterators point to different Nodes, false otherwise.

Definition at line 523 of file SkipTrie.hpp.

{
    return !(*this == other); // Delegate to operator==
}

operator*()

template<typename CHAR_T , unsigned CHAR_SIZE_BITS>

const BitString< CHAR_T, CHAR_SIZE_BITS > & SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator::operator* ( ) const

noexcept

Dereferences the iterator to access the key of the current node.

Returns

const KEY_T& A constant reference to the BitString key at the iterator's current position.

Definition at line 505 of file SkipTrie.hpp.

{
    return *m_node->key;
}

operator++() [1/2]

template<typename CHAR_T , unsigned CHAR_SIZE_BITS>

SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator & SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator::operator++ ( )

noexcept

Pre-increments the iterator to the next node in its designated direction.

Returns

Iterator& A reference to the incremented iterator.

Definition at line 490 of file SkipTrie.hpp.

{
    m_node = m_node->next_node(m_direction);
    return *this;
}

operator++() [2/2]

template<typename CHAR_T , unsigned CHAR_SIZE_BITS>

SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator::operator++ ( int  )

noexcept

Post-increments the iterator.

Returns

Iterator A copy of the iterator before it was incremented.

Note

Prefer pre-increment (++it) for potentially better performance.

Definition at line 497 of file SkipTrie.hpp.

{
    Iterator temp = *this;
    ++(*this); // Use pre-increment
    return temp;
}

operator->()

template<typename CHAR_T , unsigned CHAR_SIZE_BITS>

const BitString< CHAR_T, CHAR_SIZE_BITS > * SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator::operator-> ( ) const

noexcept

Dereferences the iterator to access the key pointer of the current node.

Returns

const KEY_T* A constant pointer to the BitString key at the iterator's current position.

Definition at line 511 of file SkipTrie.hpp.

{
    return m_node->key;
}

operator==()

template<typename CHAR_T , unsigned CHAR_SIZE_BITS>

bool SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator::operator== ( const Iterator &  other ) const

noexcept

Compares this iterator with another for equality.

Parameters

other

The iterator to compare against.

Returns

bool True if both iterators point to the same Node, false otherwise.

Definition at line 517 of file SkipTrie.hpp.

{
    return m_node == other.m_node;
}

Member Data Documentation

m_direction

template<typename CHAR_T , unsigned CHAR_SIZE_BITS = sizeof(CHAR_T) * 8>

Direction SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator::m_direction

private

The direction the iterator moves upon incrementing.

Definition at line 445 of file SkipTrie.hpp.

m_node

template<typename CHAR_T , unsigned CHAR_SIZE_BITS = sizeof(CHAR_T) * 8>

Node* SkipTrie< CHAR_T, CHAR_SIZE_BITS >::Iterator::m_node

private

Pointer to the current node the iterator is positioned at.

Definition at line 443 of file SkipTrie.hpp.

---

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

• src/SkipTrie.hpp