Random-access Array iterator. More...

#include <ArrayIt.h>

Inheritance diagram for utl::ArrayIt:

Public Member Functions
	ArrayIt (const Array *array, size_t offset)
	Constructor. More...

virtual int	compare (const Object &rhs) const
	Compare with another ArrayIt. More...

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

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

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

virtual Object *	get (size_t offset) const
	Get the object at the given offset. More...

Array *	getArray () const
	Get the associated array. More...

virtual size_t	offset () const
	Get the current offset. More...

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

virtual void	seek (size_t offset)
	Seek to the given offset. More...

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

virtual void	set (size_t offset, const Object *object)
	Set the object at the given offset. More...

virtual size_t	size () const
	Return the current size of the sequence. More...

virtual size_t	subtract (const RandIt &it) const
	Determine the distance between self and another random-access iterator for the same sequence. More...

ArrayIt	operator+ (size_t dist) const
	Return an ArrayIt equivalent to self, but moved forward the given number of objects. More...

ArrayIt	operator- (size_t dist) const
	Return copy of self moved backward the given number of objects. More...

size_t	operator- (const ArrayIt &it) const
	Return the distance from the given iterator to self. More...

Public Member Functions inherited from utl::RandIt
size_t	operator- (const RandIt &it) const
	Provides a user-friendly interface to subtract(). More...

Object *	operator[] (size_t offset) const
	Provides a user-friendly interface to get(). More...

Public Member Functions inherited from utl::BidIt
BidIt &	operator-- ()
	Pre-decrement operator. More...

void	operator-- (int)
	Post-decrement operator. More...

BidIt &	operator-= (size_t dist)
	Decrement operator. More...

Public Member Functions inherited from utl::FwdIt
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...

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

Random-access Array iterator.

Author: Adam McKee

Definition at line 22 of file ArrayIt.h.

Constructor & Destructor Documentation

◆ ArrayIt()

utl::ArrayIt::ArrayIt	(	const Array *	array,
		size_t	offset
	)

inline

Constructor.

Parameters

array	associated array
offset	initial offset

Definition at line 32 of file ArrayIt.h.

References utl::compare(), utl::copy(), and IFDEBUG.

Member Function Documentation

◆ compare()

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

virtual

Compare with another ArrayIt.

self and rhs are equal if they iterate over the same array, and their offsets are equal.

Reimplemented from utl::FwdIt.

◆ copy()

virtual void utl::ArrayIt::copy ( const Object & rhs )

virtual

Copy another ArrayIt.

Make self's array and offset the same as the given ArrayIt.

Reimplemented from utl::FwdIt.

◆ forward()

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

virtual

Move forward the given number of objects.

Note: if there are "holes" in the array, this may not be equivalent to adding dist to the current offset!

Implements utl::FwdIt.

Referenced by operator+().

◆ get() [1/2]

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

inlinevirtual

Get the current object.

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

Implements utl::RandIt.

Definition at line 57 of file ArrayIt.h.

◆ get() [2/2]

virtual Object* utl::ArrayIt::get ( size_t offset ) const

inlinevirtual

Get the object at the given offset.

Returns: object at offset (nullptr if none)

Parameters

offset array offset

Implements utl::RandIt.

Definition at line 69 of file ArrayIt.h.

References ASSERTD.

◆ getArray()

Array* utl::ArrayIt::getArray ( ) const

inline

Get the associated array.

Definition at line 77 of file ArrayIt.h.

References utl::reverse().

◆ offset()

virtual size_t utl::ArrayIt::offset ( ) const

virtual

Get the current offset.

Implements utl::RandIt.

◆ reverse()

virtual void utl::ArrayIt::reverse ( size_t dist = 1 )

virtual

Move backward the given number of objects.

If the beginning of the sequence is reached, backward movement will stop without error.

Parameters

dist	distance to move backward

Implements utl::BidIt.

Referenced by operator-().

◆ seek()

virtual void utl::ArrayIt::seek ( size_t offset )

inlinevirtual

Seek to the given offset.

Implements utl::RandIt.

Definition at line 87 of file ArrayIt.h.

References ASSERTD.

◆ set() [1/2]

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

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

Implements utl::RandIt.

◆ set() [2/2]

virtual void utl::ArrayIt::set	(	size_t	offset,
		const Object *	object
	)

inlinevirtual

Set the object at the given offset.

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

Parameters

offset	position within sequence
object	object to put at offset

Implements utl::RandIt.

Definition at line 96 of file ArrayIt.h.

References ASSERTD.

◆ size()

virtual size_t utl::ArrayIt::size ( ) const

inlinevirtual

Return the current size of the sequence.

Implements utl::RandIt.

Definition at line 103 of file ArrayIt.h.

◆ subtract()

virtual size_t utl::ArrayIt::subtract ( const RandIt & it ) const

virtual

Determine the distance between self and another random-access iterator for the same sequence.

This is calculated simply as the difference between the current offsets of the two iterators.

Returns: self.offset() - it.offset()

Parameters

it	iterator to compare with

Reimplemented from utl::RandIt.

◆ operator+()

ArrayIt utl::ArrayIt::operator+ ( size_t dist ) const

inline

Return an ArrayIt equivalent to self, but moved forward the given number of objects.

Returns: result iterator

Parameters

dist	number of objects to move forward

Definition at line 115 of file ArrayIt.h.

References forward().

◆ operator-() [1/2]

ArrayIt utl::ArrayIt::operator- ( size_t dist ) const

inline

Return copy of self moved backward the given number of objects.

Returns: result

Parameters

dist	number of objects to move backward

Definition at line 127 of file ArrayIt.h.

References reverse().

◆ operator-() [2/2]

size_t utl::ArrayIt::operator- ( const ArrayIt & it ) const

inline

Return the distance from the given iterator to self.

Definition at line 135 of file ArrayIt.h.

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

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

ArrayIt.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ArrayIt()

Member Function Documentation

◆ compare()

◆ copy()

◆ forward()

◆ get() [1/2]

◆ get() [2/2]

◆ getArray()

◆ offset()

◆ reverse()

◆ seek()

◆ set() [1/2]

◆ set() [2/2]

◆ size()

◆ subtract()

◆ operator+()

◆ operator-() [1/2]

◆ operator-() [2/2]