The SplHeap class

(PHP 5 >= 5.3.0)

Introduction

The SplHeap class provides the main functionalities of a Heap.

abstract SplHeap implements Iterator , Countable {

/* Methods */

__construct ( void )

abstract int compare ( mixed $value1 , mixed $value2 )

int count ( void )

mixed current ( void )

mixed extract ( void )

void insert ( mixed $value )

bool isEmpty ( void )

mixed key ( void )

void next ( void )

void recoverFromCorruption ( void )

void rewind ( void )

mixed top ( void )

bool valid ( void )

}

SplHeap::compare — Compare elements in order to place them correctly in the heap while sifting up.
SplHeap::__construct — Constructs a new empty heap
SplHeap::count — Counts the number of elements in the heap.
SplHeap::current — Return current node pointed by the iterator
SplHeap::extract — Extracts a node from top of the heap and sift up.
SplHeap::insert — Inserts an element in the heap by sifting it up.
SplHeap::isEmpty — Checks whether the heap is empty.
SplHeap::key — Return current node index
SplHeap::next — Move to the next node
SplHeap::recoverFromCorruption — Recover from the corrupted state and allow further actions on the heap.
SplHeap::rewind — Rewind iterator back to the start (no-op)
SplHeap::top — Peeks at the node from the top of the heap
SplHeap::valid — Check whether the heap contains more nodes