libUTL++
utl::HeapIt Class Reference

Bi-directional Heap iterator. More...

#include <HeapIt.h>

Inheritance diagram for utl::HeapIt:

Public Member Functions

 HeapIt (const Heap *heap, size_t idx)
 Constructor. More...
 
virtual int compare (const Object &rhs) const
 Compare with another HeapIt. More...
 
virtual void copy (const Object &rhs)
 Copy another HeapIt. More...
 
virtual void forward (size_t dist=1)
 Move forward the given number of objects. More...
 
virtual Objectget () const
 Get the current object. More...
 
HeapgetHeap () const
 Get the associated Heap. More...
 
size_t getIdx () const
 Get the heap index. More...
 
virtual void reverse (size_t dist=1)
 Move backward the given number of objects. More...
 
virtual void set (const Object *object)
 Set the current object. More...
 
- Public Member Functions inherited from utl::BidIt
BidItoperator-- ()
 Pre-decrement operator. More...
 
void operator-- (int)
 Post-decrement operator. More...
 
BidItoperator-= (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...
 
Objectoperator* () const
 Pointer dereference operator. More...
 
FwdItoperator++ ()
 Pre-increment operator. More...
 
void operator++ (int)
 Post-increment operator. More...
 
FwdItoperator+= (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 Objectowner () 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 ObjectgetKey () const
 Get the key for this object. More...
 
bool hasKey () const
 Determine whether or not the object has a key. More...
 
virtual const ObjectgetProxiedObject () const
 Get the proxied object (= self if none). More...
 
virtual ObjectgetProxiedObject ()
 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 ObjectserializeInNullable (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 ObjectserializeInBoxed (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

Bi-directional Heap iterator.

Author
Adam McKee

Definition at line 22 of file HeapIt.h.

Constructor & Destructor Documentation

◆ HeapIt()

utl::HeapIt::HeapIt ( const Heap heap,
size_t  idx 
)
inline

Constructor.

Parameters
heapassociated heap
idxheap index

Definition at line 32 of file HeapIt.h.

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

Member Function Documentation

◆ compare()

virtual int utl::HeapIt::compare ( const Object rhs) const
virtual

Compare with another HeapIt.

Reimplemented from utl::FwdIt.

◆ copy()

virtual void utl::HeapIt::copy ( const Object rhs)
virtual

Copy another HeapIt.

Reimplemented from utl::FwdIt.

◆ forward()

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

Move forward the given number of objects.

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

Parameters
distdistance to move forward

Implements utl::FwdIt.

◆ get()

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

Get the current object.

Returns
current object (nullptr if at end of sequence)

Implements utl::FwdIt.

Reimplemented in utl::THeapIt< T >.

◆ getHeap()

Heap* utl::HeapIt::getHeap ( ) const
inline

Get the associated Heap.

Definition at line 51 of file HeapIt.h.

◆ getIdx()

size_t utl::HeapIt::getIdx ( ) const
inline

Get the heap index.

Definition at line 58 of file HeapIt.h.

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

◆ reverse()

virtual void utl::HeapIt::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
distdistance to move backward

Implements utl::BidIt.

◆ set()

virtual void utl::HeapIt::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
objectobject to put at current position

Implements utl::FwdIt.


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