RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSCommon > DataStructures > Classes

THeap Class

Defines a heap which uses a user passed Compare function to sort the object items in the heap.

A heap is a complete binary tree where every node's value is guaranteed to be greater (or lesser depending on Order and its comparison function) than its children's values. The Count is 0 to Max-1.

Namespace: DataStructures

	Name	Description
	Create	Overloaded. Creates and initializes the heap (Inherited from DataStructures.TCustomHeap.)
	Create(TCompareFunc)	Overloaded. Creates the heap and uses the CompareFunc function to sort the items in the heap
	Create(THeapElementClass)	Overloaded. Creates and initializes the heap. The ElementClass parameter specifies the THeapElement class to create for every node in the heap. (Inherited from DataStructures.TCustomHeap.)

Top

	Name	Description
	Count	Returns the number of items in the heap (Inherited from DataStructures.TCustomHeap.)
	ElementClass	Specifies the heap element class to create for every node in the heap. (Inherited from DataStructures.TCustomHeap.)
	Element[Integer]	Returns the heap element at the specified position (Inherited from DataStructures.TCustomHeap.)
	Heap	Stores the nodes that make up the heap (Inherited from DataStructures.TCustomHeap.)
	Item[Integer]	Returns the item in the heap at the specified position. (Inherited from DataStructures.TCustomHeap.)
	Order	Specifies the order of items in the heap. (Inherited from DataStructures.TCustomHeap.)

Top

	Name	Description
	Add(TObject)	Adds the item to the heap. When an item is added to the heap. It is pushed up from the bottom of the heap (the tree) until it is not bigger (according to Order) than any of its parents.
	Assign(TPersistent)	Represents method Assign(TPersistent). (Overrides DataStructures.TCustomHeap.Assign(TPersistent).)
	Clear	Clears or empties the heap. (Inherited from DataStructures.TCustomHeap.)
	Delete(Integer)	Deletes the node or heap element at the specified index in the heap. The item at the specified node is returned. If the item to delete is the last one, delete it and shrink the tree, the tree will still be a heap. Otherwise, delete replace the item with the lowest, rightmost item in the heap and "reheapify".
	Delete(THeapElement)	Overloaded. Deletes the heap element from the heap. The item at the specified node is returned. (Inherited from DataStructures.TCustomHeap.)
	GetCount	Returns the number of items in the heap (Inherited from DataStructures.TCustomHeap.)
	GetItem(Integer)	Returns the item in the heap at the specified position. (Inherited from DataStructures.TCustomHeap.)
	IndexOf(THeapElement)	Overloaded. Returns the index of the node in the heap. (Inherited from DataStructures.TCustomHeap.)
	IndexOf(TObject)	Finds an item in the heap and returns its index in the heap. The heap is assumed to be sorted .
	ModifyPriority(Integer)	Overloaded. Modifies the priority the heap element at the specified index position in the heap. The new index of the element is returned.
	ModifyPriority(THeapElement)	Overloaded. Modifies the priority the heap element in the heap. The index of the element is returned. (Overrides DataStructures.TCustomHeap.ModifyPriority(THeapElement).)
	PushDown(Integer)	Push the Parent down the tree if it is smaller (according to Order) than one of its children The DataStructures.TCustomHeap.PushUp(Integer) and DataStructures.TCustomHeap.PushDown(Integer) methods maintain the sort order of the heap. These methods are O(n) in efficiency.
	PushUp(Integer)	Push the last value up the tree until it is not bigger (according to Order) than any of its parents. The DataStructures.TCustomHeap.PushUp(Integer) and DataStructures.TCustomHeap.PushDown(Integer) methods maintain the sort order of the heap.
	SetOrder(THeapOrder)	Represents method SetOrder(THeapOrder). (Inherited from DataStructures.TCustomHeap.)

Top

RiverSoftAVG Products Help

Reference