name: PriorityQueue<TObject> : public DstrBase

synopsis:


g++ [flags ...] file ... -l /isip/tools/lib/$ISIP_BINARY/lib_dstr_a

#include <PriorityQueue.h>

boolean push(TObject* item, COMPARE_FUNC comp_func = compare);
TObject* pop(TObject* item = (TObject*)NULL);
const TObject* top() const;
TObject* top();
boolean isEmpty() const;
long length() const;
long getCapacity() const;
boolean setLength(long length, boolean preserve_values = true);
boolean setCapacity(long capacity, boolean preserve_values = true);

quick start:


// declare a priority queue
//
Long* lng_00;
Long lng_01(3);
PriorityQueue<Long> pq_00;

pq_0.push(&lng_01);
lng_01 = pq_0.top();
pq_0.pop(&lng_01);

description:

This class implements a standard priority queue using a vector to implement the underlying heap data structure.

Introduction to Algorithms

dependencies:

public constants:

define the class name:

static const String CLASS_NAME = L"PriorityQueue";

define public constants:

static const String CLASS_NAME;

static const String DEF_PARAM;

static const long DEF_END_POS = -1;

error codes:

error codes indicating general errors:

protected data:

declare comparison function for the items in the priority queue:

typedef Integral::COMPARE (*COMPARE_FUNC)(TObject* item1, TObject* item2);

declare the internal structure of the priority queue:

TObject** v_d;

declare the allocation mode:

ALLOCATION alloc_d;

declare number of elements of this vector:

Long length_d;

declare the maximum number of elements:

Long capacity_d;

declare the debugging parameters:
```
static Integral::DEBUG debug_level_d;
```
define the memory manager:
```
static MemoryManager mgr_d;
```

required public methods:

static methods:
```
static const String& name();
```

debug methods:

static boolean setDebug(Integral::DEBUG debug_level);

boolean debug(const unichar* message) const;

destructor/constructor(s):

~PriorityQueue();

PriorityQueue(ALLOCATION alloc = DEF_ALLOCATION);

PriorityQueue(const PriorityQueue<TObject>& copy_queue);

assign methods:

boolean assign(const PriorityQueue<TObject>& copy_stack);

operator= method:

PriorityQueue<TObject>& operator=(const PriorityQueue<TObject>& arg);

i/o methods:

long sofSize() const;

boolean read(Sof& sof, long tag);

boolean write(Sof& sof, long tag) const;

boolean read(Sof& sof, long tag, const String& name);

boolean write(Sof& sof, long tag, const String& name) const;

boolean readData(Sof& sof, const String& pname = DEF_PARAM, long size = SofParser::FULL_OBJECT, boolean param = true, boolean nested = true);

boolean writeData(Sof& sof, const String& pname = DEF_PARAM) const;

equality methods:

boolean eq(const PriorityQueue<TObject>& arg) const;

memory management methods:

static void* operator new(size_t size);

static void* operator new[](size_t size);

static void operator delete(void* ptr);

static void operator delete[](void* ptr);

static boolean setGrowSize(long grow_size);

boolean clear(Integral::CMODE cmode = Integral::DEF_CMODE);

class-specific public methods:

declare class specific methods:

boolean push(TObject* item, COMPARE_FUNC comp_func = compare);

TObject* pop(TObject* item = (TObject*)NULL);

const TObject* top() const;

TObject* top();

boolean isEmpty() const;

long length() const;

long getCapacity() const;

boolean setLength(long length, boolean preserve_values = true);

boolean setCapacity(long capacity, boolean preserve_values = true);

private methods:

declare private methods:

long parent(long val);

long left(long val);

long right(long val);

static Integral::COMPARE compare(TObject* item1, TObject* item2);

boolean heapify(long index, COMPARE_FUNC comp_func = compare);

boolean buildHeap();

boolean heapSort();

TObject* accessByMode(TObject* item);

examples:

none.

notes:

none.