Objeck Documentation

All Bundles

Bundle Generic collections library: Vector (dynamic array), Map (hash map), Set, MultiMap, Stack, Queue, and Pair. Provides typed iteration, sorting, filtering, and functional operations (Reduce, Any, All). Compile with -lib gen_collect.

Heap

Generic binary heap

heap := Collection.Heap->New(Collection.Heap->Order->MIN)<IntRef>;
        
heap->Insert(IntRef->New(3));
heap->Insert(IntRef->New(1));
heap->Insert(IntRef->New(9));
heap->Insert(IntRef->New(8));
heap->Insert(IntRef->New(6));
heap->Insert(IntRef->New(2));

while(<>heap->IsEmpty()) {
   heap->Pop()->PrintLine();
};

Operations

New
Capacity
Insert
IsEmpty
Pop
Size
ToArray
ToString
Top

Capacity #

Returns the heap capacity

method : public : Capacity() ~ Int

Return

Type	Description
Int	heap capacity

Example

heap := Collection.Heap->New(Collection.Heap->Order->MIN)<IntRef>;
heap->Capacity()->PrintLine(); # initial capacity (16)

Insert #

Inserts a value into the heap and extends the heap size if necessary

method : public : Insert(value:H) ~ Nil

Parameters

Name	Type	Description
value	H	value to insert

Example

heap := Collection.Heap->New(Collection.Heap->Order->MIN)<IntRef>;
heap->Insert(IntRef->New(7));
heap->Insert(IntRef->New(2));
heap->Insert(IntRef->New(5));
heap->Top()->PrintLine(); # 2

IsEmpty #

Checks to see if the heap is empty

method : public : IsEmpty() ~ Bool

Return

Type	Description
Bool	true if empty, false otherwise

Example

heap := Collection.Heap->New(Collection.Heap->Order->MIN)<IntRef>;
heap->IsEmpty()->PrintLine(); # true
heap->Insert(IntRef->New(1));
heap->IsEmpty()->PrintLine(); # false

New # constructor

Constructor

New(array:H[], order:Heap->Order)

Parameters

Name	Type	Description
array	H[]	array of values to insert
order	Heap->Order	sort order

Example

values := IntRef->New[3];
values[0] := 5; values[1] := 2; values[2] := 8;
heap := Collection.Heap->New(values, Collection.Heap->Order->MIN)<IntRef>;
heap->Pop()->PrintLine(); # 2

New # constructor

Constructor

New(order:Heap->Order)

Parameters

Name	Type	Description
order	Heap->Order	sort order

Example

heap := Collection.Heap->New(Collection.Heap->Order->MAX)<IntRef>;
heap->Insert(IntRef->New(5));
heap->Insert(IntRef->New(9));
heap->Pop()->PrintLine(); # 9

Pop #

Pop either the smallest or largest value depending upon the sort order

method : public : Pop() ~ H

Return

Type	Description
H	smallest or largest value

Example

heap := Collection.Heap->New(Collection.Heap->Order->MIN)<IntRef>;
heap->Insert(IntRef->New(4));
heap->Insert(IntRef->New(1));
heap->Pop()->PrintLine(); # 1
heap->Pop()->PrintLine(); # 4

Pop #

Searches and pops the given value

method : public : Pop(value:H) ~ Bool

Parameters

Name	Type	Description
value	H	value to remove

Return

Type	Description
Bool	true if successful, false otherwise

Example

heap := Collection.Heap->New(Collection.Heap->Order->MIN)<IntRef>;
heap->Insert(IntRef->New(3));
heap->Insert(IntRef->New(7));
heap->Pop(IntRef->New(7))->PrintLine(); # true
heap->Size()->PrintLine();              # 1

Size #

Size of heap, including Nil values

method : public : Size() ~ Int

Return

Type	Description
Int	size of heap

Example

heap := Collection.Heap->New(Collection.Heap->Order->MIN)<IntRef>;
heap->Insert(IntRef->New(1));
heap->Insert(IntRef->New(2));
heap->Size()->PrintLine(); # 2

ToArray #

Returns a list of non-Nil values

method : public : ToArray() ~ H[]

Return

Type	Description
H[]	list of values

Example

heap := Collection.Heap->New(Collection.Heap->Order->MIN)<IntRef>;
heap->Insert(IntRef->New(3));
heap->Insert(IntRef->New(1));
arr := heap->ToArray();
arr[0]->PrintLine(); # smallest element

ToString #

Formats the collection into a string. If an element implements the 'Stringify' interface, it's 'ToString()' is called.

method : public : ToString() ~ String

Return

Type	Description
String	string representation

Example

heap := Collection.Heap->New(Collection.Heap->Order->MIN)<IntRef>;
heap->Insert(IntRef->New(3));
heap->Insert(IntRef->New(1));
heap->ToString()->PrintLine();

Top #

Check the top of the stack

method : public : Top() ~ H

Return

Type	Description
H	value on the top of stack, Nil if stack is empty

Example

heap := Collection.Heap->New(Collection.Heap->Order->MIN)<IntRef>;
heap->Insert(IntRef->New(5));
heap->Insert(IntRef->New(2));
heap->Top()->PrintLine(); # 2