The SplMaxHeap class

(PHP 5 >= 5.3.0)

Introduction

The SplMaxHeap class provides the main functionalities of a heap, keeping the maximum on the top.

SplMaxHeap extends SplHeap implements Iterator , Countable {

/* Methods */

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

/* Inherited methods */

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

public int SplHeap::count ( void )

public mixed SplHeap::current ( void )

public mixed SplHeap::extract ( void )

public void SplHeap::insert ( mixed $value )

public bool SplHeap::isEmpty ( void )

public mixed SplHeap::key ( void )

public void SplHeap::next ( void )

public void SplHeap::recoverFromCorruption ( void )

public void SplHeap::rewind ( void )

public mixed SplHeap::top ( void )

public bool SplHeap::valid ( void )

}

SplMaxHeap::compare — Compare elements in order to place them correctly in the heap while sifting up.