Random-access iterator abstraction. More...

#include <RandIt.h>

Inheritance diagram for utl::RandIt:

[legend]

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

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

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

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

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

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

virtual size_t	size () const =0
	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...

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
virtual void	reverse (size_t dist=1)=0
	Move backward the given number of objects. More...

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
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...

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 iterator abstraction.

RandIt is a random-access iterator abstraction. RandIt inherits from BidIt, and adds the ability to randomly access the sequence of objects.

Author: Adam McKee

Definition at line 25 of file RandIt.h.

Member Function Documentation

◆ get() [1/2]

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

pure virtual

Get the current object.

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

Implements utl::FwdIt.

Implemented in utl::TRandIt< T >, and utl::ArrayIt.

Referenced by utl::swap().

◆ get() [2/2]

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

pure virtual

Get the object at the given offset.

Returns: found object (nullptr if offset is >= end)

Parameters

offset position of object within sequence

Implemented in utl::TRandIt< T >, and utl::ArrayIt.

◆ offset()

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

pure virtual

Get the current offset.

Implemented in utl::ArrayIt, and utl::TRandIt< T >.

Referenced by subtract().

◆ seek()

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

pure virtual

Seek to the given offset.

Implemented in utl::ArrayIt, and utl::TRandIt< T >.

◆ set() [1/2]

virtual void utl::RandIt::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

Implements utl::FwdIt.

Implemented in utl::TRandIt< T >, and utl::ArrayIt.

Referenced by utl::swap().

◆ set() [2/2]

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

pure virtual

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

Implemented in utl::ArrayIt, and utl::TRandIt< T >.

◆ size()

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

pure virtual

Return the current size of the sequence.

Implemented in utl::ArrayIt, and utl::TRandIt< T >.

◆ subtract()

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

inlinevirtual

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 in utl::ArrayIt, and utl::TRandIt< T >.

Definition at line 69 of file RandIt.h.

References offset().

◆ operator-()

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

inline

Provides a user-friendly interface to subtract().

Definition at line 75 of file RandIt.h.

◆ operator[]()

Object* utl::RandIt::operator[] ( size_t offset ) const

inline

Provides a user-friendly interface to get().

Definition at line 81 of file RandIt.h.

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

RandIt.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get() [1/2]

◆ get() [2/2]

◆ offset()

◆ seek()

◆ set() [1/2]

◆ set() [2/2]

◆ size()

◆ subtract()

◆ operator-()

◆ operator[]()