The SplHeap class

Introduction

The SplHeap class provides the main functionalities of a Heap.

abstract SplHeap

implements Iterator Countable

/* Methods */

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

public int count()

public mixed current()

public mixed extract()

public true insert(mixed $value)

public bool isCorrupted()

public bool isEmpty()

public int key()

public void next()

public true recoverFromCorruption()

public void rewind()

public mixed top()

public bool valid()

Table of Contents

SplHeap::compare — Compare elements in order to place them correctly in the heap while sifting up
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