original::forwardChain< TYPE, ALLOC >::Iterator Class Reference

Iterator for forwardChain, supports single-direction traversal. More...

#include <forwardChain.h>

Inheritance diagram for original::forwardChain< TYPE, ALLOC >::Iterator:

Collaboration diagram for original::forwardChain< TYPE, ALLOC >::Iterator:

Public Member Functions
	Iterator (const Iterator &other)
	Copy constructor for Iterator.
Iterator &	operator= (const Iterator &other)
	Assignment operator for Iterator.
Iterator *	clone () const override
	Clones the iterator.
bool	atPrev (const iterator< TYPE > *other) const override
	Checks if this iterator is at the previous element relative to another iterator.
bool	atNext (const iterator< TYPE > *other) const override
	Checks if this iterator is at the next element relative to another iterator.
std::string	className () const override
	Gets the class name of the iterator.
Public Member Functions inherited from original::singleDirectionIterator< TYPE >
	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.

Public Attributes
friend	forwardChain

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 with type-specific formatting.
template<Printable TYPE>
static std::string	formatString (const TYPE &t)
	Specialization for types deriving from printable.
template<EnumType TYPE>
static std::string	formatString (const TYPE &t)
	Specialization for enum types with type-safe formatting.
template<typename TYPE >
static std::string	formatString (TYPE *const &ptr)
	Pointer-specific formatting with null safety.
template<typename TYPE >
static const char *	formatCString (const TYPE &t)
	C-string cache for temporary usage with static storage.
template<typename TYPE >
static std::string	formatEnum (const TYPE &t)
	Enum formatting utility with underlying value extraction.
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
Protected Member Functions inherited from original::singleDirectionIterator< TYPE >
	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.
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, typename ALLOC = allocator<TYPE>>
class original::forwardChain< TYPE, ALLOC >::Iterator

Iterator for forwardChain, supports single-direction traversal.

Allows forward iteration through the forwardChain with operations like cloning, comparison, etc. Provides read and write access to elements.

Constructor & Destructor Documentation

Iterator()

template<typename TYPE , typename ALLOC >

original::forwardChain< TYPE, ALLOC >::Iterator::Iterator

(

const Iterator &

other

)

Copy constructor for Iterator.

Parameters

other

The iterator to copy from.

Member Function Documentation

atNext()

template<typename TYPE , typename ALLOC >

auto original::forwardChain< TYPE, ALLOC >::Iterator::atNext ( const iterator< TYPE > *  other ) const

overridevirtual

Checks if this iterator is at the next element relative to another iterator.

Parameters

other

The iterator to compare to.

Returns

True if this iterator is at the next element, false otherwise.

Implements original::iterator< TYPE >.

atPrev()

template<typename TYPE , typename ALLOC >

auto original::forwardChain< TYPE, ALLOC >::Iterator::atPrev ( const iterator< TYPE > *  other ) const

overridevirtual

Checks if this iterator is at the previous element relative to another iterator.

Parameters

other

The iterator to compare to.

Returns

True if this iterator is at the previous element, false otherwise.

Implements original::iterator< TYPE >.

className()

template<typename TYPE , typename ALLOC >

auto original::forwardChain< TYPE, ALLOC >::Iterator::className ( ) const

overridevirtual

Gets the class name of the iterator.

Returns

The class name as a string.

Reimplemented from original::printable.

clone()

template<typename TYPE , typename ALLOC >

auto original::forwardChain< TYPE, ALLOC >::Iterator::clone ( ) const

overridevirtual

Clones the iterator.

Returns

A new iterator pointing to the same position.

Exceptions

std::bad_alloc

if memory allocation fails

Implements original::baseIterator< TYPE >.

operator=()

template<typename TYPE , typename ALLOC >

auto original::forwardChain< TYPE, ALLOC >::Iterator::operator=

(

const Iterator &

other

)

Assignment operator for Iterator.

Parameters

other

The iterator to assign from.

Returns

A reference to this iterator.

---

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

• src/core/forwardChain.h