The SplMaxHeap class

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

    Introduction

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

    Class synopsis

    classSplMaxHeapextendsSplHeap {
    protectedcompare(mixed$value1, mixed$value2): int
    protectedSplHeap::compare(mixed$value1, mixed$value2): int
    publicSplHeap::count(): int
    publicSplHeap::current(): mixed
    publicSplHeap::extract(): mixed
    publicSplHeap::insert(mixed$value): true
    publicSplHeap::isCorrupted(): bool
    publicSplHeap::isEmpty(): bool
    publicSplHeap::key(): int
    publicSplHeap::next(): void
    publicSplHeap::recoverFromCorruption(): bool
    publicSplHeap::rewind(): void
    publicSplHeap::top(): mixed
    publicSplHeap::valid(): bool
    }

    Table of Contents

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