public

Inheritance Graph

graph BT
	UpdatableHeap
	click UpdatableHeap "classUtil_1_1UpdatableHeap"

Description

Classes

   
class Util::UpdatableHeap::UpdatableHeapElement

Public Functions

   
   
  UpdatableHeap()
   
  ~UpdatableHeap()
   
UpdatableHeapElement * insert(Key_t cost, const Data_t & data)
   
void erase( UpdatableHeapElement * h)
Deletehfrom heap. Make surehis from this heap!
   
void pop()
Delete top element from heap.
   
void clear()
Delete all elements from heap.
   
void update( UpdatableHeapElement * h, Key_t newCost)
Update cost ofhto newCost keeping heap in order.
   
UpdatableHeapElement * top() const
Return pointer to top element (root)
   
size_t size() const
Return number of elements in heap.

Documentation

function
Util::UpdatableHeap::UpdatableHeap

public inline
   
   
UpdatableHeap( )

Defined in Util/UpdatableHeap.h:72

function
Util::UpdatableHeap::~UpdatableHeap

public inline
   
   
~UpdatableHeap( )

Defined in Util/UpdatableHeap.h:76

function
Util::UpdatableHeap::insert

public inline
     
     
UpdatableHeapElement * insert( Key_t cost,
  const Data_t & data
)    

Add a new element to the heap keyed on cost

Returns

UpdatableHeapElement representing these data in the heap, needed for update etc.

Defined in Util/UpdatableHeap.h:85

function
Util::UpdatableHeap::erase

public inline
     
     
void erase( UpdatableHeapElement * h )

Deletehfrom heap. Make surehis from this heap!

Defined in Util/UpdatableHeap.h:88

function
Util::UpdatableHeap::pop

public inline
   
   
void pop( )

Delete top element from heap.

Defined in Util/UpdatableHeap.h:91

function
Util::UpdatableHeap::clear

public inline
   
   
void clear( )

Delete all elements from heap.

Defined in Util/UpdatableHeap.h:96

function
Util::UpdatableHeap::update

public inline
     
     
void update( UpdatableHeapElement * h,
  Key_t newCost
)    

Update cost ofhto newCost keeping heap in order.

Defined in Util/UpdatableHeap.h:104

function
Util::UpdatableHeap::top

public const inline
   
   
UpdatableHeapElement * top( ) const

Return pointer to top element (root)

Defined in Util/UpdatableHeap.h:115

function
Util::UpdatableHeap::size

public const inline
   
   
size_t size( ) const

Return number of elements in heap.

Defined in Util/UpdatableHeap.h:120