The SplMaxHeap class

The SplMaxHeap class

Introduction

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

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

Class synopsis

class SplMaxHeap extends SplHeap implements Iterator, Countable {

/* Methods */

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

/* Inherited methods */

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

public SplHeap::count(): int

public SplHeap::current(): mixed

public SplHeap::extract(): mixed

public SplHeap::insert(mixed $value): bool

public SplHeap::isCorrupted(): bool

public SplHeap::isEmpty(): bool

public SplHeap::key(): int

public SplHeap::next(): void

public SplHeap::recoverFromCorruption(): bool

public SplHeap::rewind(): void

public SplHeap::top(): mixed

public SplHeap::valid(): bool

}

Table of Contents

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

© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.splmaxheap.php