Forward iterator abstraction. More...

#include <FwdIt.h>

Inheritance diagram for utl::FwdIt:

[legend]

Public Member Functions
virtual int	compare (const Object &rhs) const
	Compare with another iterator. More...

virtual void	copy (const Object &rhs)
	Copy another iterator.

virtual void	forward (size_t dist=1)=0
	Move forward the given number of objects. More...

virtual Object *	get () const =0
	Get the current object. More...

bool	isConst () const
	Get the const flag. More...

void	setConst (bool p_const)
	Set the const flag. More...

virtual bool	isEnd () const
	Determine whether the iterator points to the end of the sequence. More...

virtual void	set (const Object *object)=0
	Set the current object. More...

Object *	operator* () const
	Pointer dereference operator. More...

FwdIt &	operator++ ()
	Pre-increment operator. More...

void	operator++ (int)
	Post-increment operator. More...

FwdIt &	operator+= (size_t dist)
	Increment operator. More...

bool	isValid (const utl::Object *owner=nullptr) const
	Assert that the iterator is valid. More...

void	invalidate () const
	Invalidate the iterator. More...

bool	hasSameOwner (const FwdIt *it) const
	Query if self has the same owner as the given iterator. More...

const Object *	owner () const
	Get the owner. More...

void	setOwner (const Object *owner, bool notifyOwner=true) const
	Set the owner. More...

Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...

virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...

virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...

virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream. More...

void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...

virtual const Object &	getKey () const
	Get the key for this object. More...

bool	hasKey () const
	Determine whether or not the object has a key. More...

virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...

virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...

virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...

bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...

virtual String	toString () const
	Return a string representation of self. More...

	operator String () const
	Conversion to String. More...

size_t	allocatedSize () const
	Get the total allocated size of this object. More...

virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...

virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...

virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...

bool	operator< (const Object &rhs) const
	Less-than operator. More...

bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...

bool	operator> (const Object &rhs) const
	Greater-than operator. More...

bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...

bool	operator== (const Object &rhs) const
	Equal-to operator. More...

bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...

void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...

void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...

virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...

void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...

static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...

static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...

static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...

static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Protected Member Functions inherited from utl::FlagsMI
	FlagsMI ()
	Constructor. More...

virtual	~FlagsMI ()
	Destructor. More...

void	copyFlags (const FlagsMI &rhs)
	Copy the given flags. More...

void	copyFlags (const FlagsMI &rhs, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...

void	copyFlags (uint64_t flags, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...

bool	getFlag (uint_t flagNum) const
	Get a user-defined flag. More...

void	setFlag (uint_t flagNum, bool val)
	Set a user-defined flag. More...

uint64_t	getFlagsNumber (uint64_t mask, uint64_t shift=0)
	Get a multi-bit value in the flags data (which is stored as one 64-bit integer). More...

void	setFlagsNumber (uint64_t mask, uint64_t shift, uint64_t num)
	Set a multi-bit value in the flags data (which is stored as one 64-bit integer). More...

uint64_t	getFlags () const
	Get the flags. More...

void	setFlags (uint64_t flags)
	Set the flags. More...

Detailed Description

Forward iterator abstraction.

A forward iterator allows forward movement through a sequence of objects. FwdIt is the most basic kind of iterator. More powerful iterators such as bi-directional (BidIt) and random-access (RandIt) are derived from it.

Author: Adam McKee

Definition at line 26 of file FwdIt.h.

Member Function Documentation

◆ compare()

virtual int utl::FwdIt::compare ( const Object & rhs ) const

virtual

Compare with another iterator.

The default implementation performs the comparison by comparing the objects referred to by each iterator (as determined by calling get()).

Reimplemented from utl::Object.

Reimplemented in utl::BinTreeBfsIt, utl::BinTreeIt, utl::ArrayIt, utl::DequeIt, utl::HashtableIt, utl::SkipListIt, utl::HeapIt, utl::ListIt, utl::TBidIt< T >, utl::TFwdIt< T >, and utl::TRandIt< T >.

◆ forward()

virtual void utl::FwdIt::forward ( size_t dist = 1 )

pure virtual

Move forward the given number of objects.

If the end of the sequence is reached, forward movement will stop without error.

Parameters

dist	distance to move forward

Implemented in utl::ArrayIt, utl::BinTreeBfsIt, utl::BinTreeIt, utl::TBidIt< T >, utl::TFwdIt< T >, utl::TRandIt< T >, utl::DequeIt, utl::HashtableIt, utl::SkipListIt, utl::HeapIt, and utl::ListIt.

◆ get()

virtual Object* utl::FwdIt::get ( ) const

pure virtual

Get the current object.

Returns: current object (nullptr if at end of sequence)

Implemented in utl::TRandIt< T >, utl::TBidIt< T >, utl::TFwdIt< T >, utl::ArrayIt, utl::BinTreeBfsIt, utl::BinTreeIt, utl::DequeIt, utl::HashtableIt, utl::SkipListIt, utl::HeapIt, utl::ListIt, utl::RandIt, utl::TDequeIt< T >, utl::THashtableIt< T >, utl::THeapIt< T >, utl::TListIt< T >, utl::TRBtreeIt< T >, and utl::TSkipListIt< T >.

◆ isConst()

bool utl::FwdIt::isConst ( ) const

inline

Get the const flag.

The const flag indicates that the sequence the iterator refers to cannot be modified by adding, changing, or removing objects. Specifically, the set() method may not be called with the const flag is true.

Definition at line 61 of file FwdIt.h.

◆ setConst()

void utl::FwdIt::setConst ( bool p_const )

inline

◆ isEnd()

virtual bool utl::FwdIt::isEnd ( ) const

inlinevirtual

Determine whether the iterator points to the end of the sequence.

Returns: true if get() = nullptr, false otherwise

Definition at line 78 of file FwdIt.h.

◆ set()

virtual void utl::FwdIt::set ( const Object * object )

pure virtual

Set the current object.

This method may not be called when the const flag is true. If self points to an object, it will be replaced by the given object (or removed if object == nullptr). If self points to the end of the sequence, the given object will be added to the sequence.

Parameters

object object to put at current position

Implemented in utl::TRandIt< T >, utl::ArrayIt, utl::HashtableIt, utl::SkipListIt, utl::BinTreeIt, utl::BinTreeBfsIt, utl::TBidIt< T >, utl::HeapIt, utl::ListIt, utl::TFwdIt< T >, utl::DequeIt, and utl::RandIt.

Referenced by utl::swap().

◆ operator*()

Object* utl::FwdIt::operator* ( ) const

inline

Pointer dereference operator.

An iterator is analagous to a pointer, so it makes intuitive sense to use this operator.

See also: get

Definition at line 97 of file FwdIt.h.

◆ operator++() [1/2]

FwdIt& utl::FwdIt::operator++ ( )

inline

Pre-increment operator.

Move forward one object.

Returns: self

Definition at line 106 of file FwdIt.h.

◆ operator++() [2/2]

void utl::FwdIt::operator++ ( int )

inline

Post-increment operator.

Move forward one object.

Returns: copy of self before moving forward

Definition at line 116 of file FwdIt.h.

◆ operator+=()

FwdIt& utl::FwdIt::operator+= ( size_t dist )

inline

Increment operator.

Move forward the given number of objects.

Returns: self

Parameters

dist	distance to move forward

Definition at line 126 of file FwdIt.h.

◆ isValid()

bool utl::FwdIt::isValid ( const utl::Object * owner = nullptr ) const

Assert that the iterator is valid.

◆ invalidate()

void utl::FwdIt::invalidate ( ) const

inline

Invalidate the iterator.

Definition at line 138 of file FwdIt.h.

◆ hasSameOwner()

bool utl::FwdIt::hasSameOwner ( const FwdIt * it ) const

inline

Query if self has the same owner as the given iterator.

Definition at line 145 of file FwdIt.h.

◆ owner()

const Object* utl::FwdIt::owner ( ) const

inline

Get the owner.

Definition at line 152 of file FwdIt.h.

References utl::deInit(), and utl::init().

◆ setOwner()

void utl::FwdIt::setOwner	(	const Object *	owner,
		bool	notifyOwner = `true`
	)		const

Set the owner.

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

FwdIt.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ compare()

◆ forward()

◆ get()

◆ isConst()

◆ setConst()

◆ isEnd()

◆ set()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ isValid()

◆ invalidate()

◆ hasSameOwner()

◆ owner()

◆ setOwner()