Edit Report a Bug

    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

    class SplMaxHeap extends SplHeap {
    /* 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): true
    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
    add a note add a note

    User Contributed Notes 1 note

    up
    0
    MuLoT [ojousset49 at yahoo dot fr]
    13 years ago
    SplMaxHeap simple example with integer values...

    <?php
    class MySimpleHeap extends SplHeap
    {
        public function  compare( $value1, $value2 ) {
            return ( $value1 - $value2 );
        }
    }

    $obj = new MySimpleHeap();
    $obj->insert( 4 );
    $obj->insert( 8 );
    $obj->insert( 1 );
    $obj->insert( 0 );

    foreach( $obj as $number ) {
        echo $number.\"\\n\";
    }

    /*
        Output display :
        8
        4
        1
        0
    */
    ?>
    add a note add a note
    To Top