Abstract base class for single-direction iterators. More...

#include <singleDirectionIterator.h>

Inheritance diagram for original::singleDirectionIterator< TYPE >:

Collaboration diagram for original::singleDirectionIterator< TYPE >:

Public Member Functions
	singleDirectionIterator (const singleDirectionIterator &other)
	Copy constructor for singleDirectionIterator.

singleDirectionIterator &	operator= (const singleDirectionIterator &other)
	Copy assignment operator for singleDirectionIterator.

singleDirectionIterator *	clone () const override
	Creates a heap-allocated copy of the iterator.

Public Member Functions inherited from original::stepIterator< TYPE >
	stepIterator (const stepIterator &other)
	Copy constructor for stepIterator.

stepIterator &	operator= (const stepIterator &other)
	Copy assignment operator for stepIterator.

stepIterator *	clone () const override
	Creates a heap-allocated copy of the iterator.

bool	hasNext () const override
	Checks if the iterator can move forward.

bool	hasPrev () const override
	Checks if the iterator can move backward.

bool	atPrev (const iterator< TYPE > *other) const override
	Checks if the current iterator is at the previous position relative to another iterator.

bool	atNext (const iterator< TYPE > *other) const override
	Checks if the current iterator is at the next position relative to another iterator.

void	next () const override
	Advances to the next position in the container.

void	prev () const override
	Retreats to the previous position in the container.

void	operator+= (integer steps) const override
	Moves forward by a specified number of steps.

void	operator-= (integer steps) const override
	Moves backward by a specified number of steps.

integer	operator- (const iterator< TYPE > &other) const override
	Calculates the number of steps between the current iterator and another iterator.

stepIterator *	getNext () const override
	Creates a new iterator pointing to the next element.

iterator< TYPE > *	getPrev () const override
	Creates a new iterator pointing to the previous element.

TYPE &	get () override
	Gets the reference of current element in the container.

TYPE	get () const override
	Gets the current element in the container.

void	set (const TYPE &data) override
	Sets the value of the current element.

bool	isValid () const override
	Checks if the iterator is valid.

std::string	className () const override
	Returns the class name of the iterator.

Public Member Functions inherited from original::baseIterator< TYPE >
	~baseIterator () override=default
	Virtual destructor for proper cleanup of derived objects.

Public Member Functions inherited from original::iterator< TYPE >
TYPE &	operator* ()
	Dereferences the iterator to get the element.

TYPE	operator* () const
	Dereferences the iterator to get a copy of the element.

void	operator++ () const
	Moves the iterator forward by one position.

void	operator++ (int postfix) const
	Moves the iterator forward by one position (postfix).

void	operator-- () const
	Moves the iterator backward by one position.

void	operator-- (int postfix) const
	Moves the iterator backward by one position (postfix).

integer	compareTo (const iterator &other) const override
	Compares two iterators to determine their relative positions.

	operator bool () const
	Checks if the iterator is valid (i.e., points to a valid element).

bool	atPrev (const iterator &other) const
	Checks if this iterator is positioned at the previous element.

bool	atNext (const iterator &other) const
	Checks if this iterator is positioned at the next element.

virtual TYPE	getElem () const
	Returns a copy of the element.

bool	equal (const iterator *other) const
	Checks if two iterators are equal.

bool	equal (const iterator &other) const
	Checks if two iterators are equal.

std::string	toString (bool enter) const override
	Returns a string representation of the iterator.

	~iterator () override=default
	Virtual destructor for proper cleanup of derived objects.

Public Member Functions inherited from original::printable
	operator std::string () const
	Explicit conversion to std::string.

	operator const char * () const
	Explicit conversion to C-style string.

const char *	toCString (bool enter) const
	Direct C-string access with formatting control.

template<typename TYPE>
auto	formatString (const TYPE &t) -> std::string

template<typename TYPE>
auto	formatCString (const TYPE &t) -> const char *

template<typename TYPE>
auto	formatEnum (const TYPE &t) -> std::string

template<typename TYPE>
auto	formatString (TYPE *const &ptr) -> std::string

Public Member Functions inherited from original::cloneable
	~cloneable () override=default
	Virtual destructor for cloneable.

Public Member Functions inherited from original::baseCloneable< cloneable >
virtual	~baseCloneable ()=default
	Virtual destructor for baseCloneable.

Public Member Functions inherited from original::comparable< iterator< TYPE > >
bool	operator== (const iterator< TYPE > &other) const
	Checks if the current object is equal to another.

bool	operator!= (const iterator< TYPE > &other) const
	Checks if the current object is not equal to another.

bool	operator< (const iterator< TYPE > &other) const
	Checks if the current object is less than another.

bool	operator> (const iterator< TYPE > &other) const
	Checks if the current object is greater than another.

bool	operator<= (const iterator< TYPE > &other) const
	Checks if the current object is less than or equal to another.

bool	operator>= (const iterator< TYPE > &other) const
	Checks if the current object is greater than or equal to another.

virtual	~comparable ()=default
	Virtual destructor for proper cleanup of derived objects.

Protected Member Functions
	singleDirectionIterator (wrapper< TYPE > *ptr)
	Protected constructor for singleDirectionIterator.

Protected Member Functions inherited from original::stepIterator< TYPE >
	stepIterator (wrapper< TYPE > *ptr)
	Protected constructor for derived classes.

bool	equalPtr (const iterator< TYPE > *other) const override
	Equality comparison for two iterators.

Protected Member Functions inherited from original::cloneable
	cloneable ()=default
	Default constructor for cloneable.

Protected Member Functions inherited from original::baseCloneable< cloneable >
	baseCloneable ()=default
	Default constructor for baseCloneable.

Additional Inherited Members
Static Public Member Functions inherited from original::printable
template<typename TYPE>
static std::string	formatString (const TYPE &t)
	Universal value-to-string conversion.

template<typename TYPE>
static std::string	formatString (TYPE *const &ptr)
	Pointer-specific formatting.

template<typename TYPE>
static const char *	formatCString (const TYPE &t)
	C-string cache for temporary usage.

template<typename TYPE>
static std::string	formatEnum (const TYPE &t)
	Enum formatting utility.

template<>
auto	formatString (const char &t) -> std::string

template<>
auto	formatString (const bool &t) -> std::string

template<>
auto	formatString (const char *const &ptr) -> std::string

Static Protected Member Functions inherited from original::stepIterator< TYPE >
static integer	ptrDistance (const stepIterator start, const stepIterator end)
	Calculates the distance between two iterators.

Protected Attributes inherited from original::stepIterator< TYPE >
wrapper< TYPE > *	_ptr
	Pointer to the current wrapper.

Detailed Description

template<typename TYPE>
class original::singleDirectionIterator< TYPE >

Abstract base class for single-direction iterators.

Template Parameters

TYPE	Type of elements being iterated

Implements core functionality for iterators that support single-direction traversal. It extends stepIterator and provides a base for all iterators that traverse elements one step at a time in a single direction (typically forward).

Constructor & Destructor Documentation

◆ singleDirectionIterator() [1/2]

template<typename TYPE>

original::singleDirectionIterator< TYPE >::singleDirectionIterator ( wrapper< TYPE > * ptr )

explicitprotected

Protected constructor for singleDirectionIterator.

Parameters

ptr	Raw pointer to the element being iterated

◆ singleDirectionIterator() [2/2]

template<typename TYPE>

original::singleDirectionIterator< TYPE >::singleDirectionIterator ( const singleDirectionIterator< TYPE > & other )

Copy constructor for singleDirectionIterator.

Parameters

other The iterator to copy from

Member Function Documentation

◆ clone()

template<typename TYPE>

auto original::singleDirectionIterator< TYPE >::clone ( ) const

overridevirtual

Creates a heap-allocated copy of the iterator.

Returns: A new heap-allocated singleDirectionIterator

Implements original::baseIterator< TYPE >.

◆ operator=()

template<typename TYPE>

auto original::singleDirectionIterator< TYPE >::operator= ( const singleDirectionIterator< TYPE > & other )

Copy assignment operator for singleDirectionIterator.

Parameters

other The iterator to copy from

Returns: A reference to this iterator

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

src/core/singleDirectionIterator.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ singleDirectionIterator() [1/2]

◆ singleDirectionIterator() [2/2]

Member Function Documentation

◆ clone()

◆ operator=()