The SplHeap class

(PHP 5 >= 5.3.0, PHP 7)

Introduction

The SplHeap class provides the main functionalities of a Heap.

abstract SplHeap implements Iterator , Countable {

/* Methods */

public __construct ( void )

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

public count ( void ) : int

public current ( void ) : mixed

public extract ( void ) : mixed

public insert ( mixed $value ) : void

public isCorrupted ( void ) : bool

public isEmpty ( void ) : bool

public key ( void ) : mixed

public next ( void ) : void

public recoverFromCorruption ( void ) : void

public rewind ( void ) : void

public top ( void ) : mixed

public valid ( void ) : bool

}

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::isCorrupted — Tells if the heap is in a corrupted state
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