The SplPriorityQueue class

(PHP 5 >= 5.3.0, PHP 7)

Introduction

The SplPriorityQueue class provides the main functionalities of a prioritized queue, implemented using a max heap.

Note: The order of elements with identical priority is undefined. It may differ from the order in which they have been inserted.

PHP: SplPriorityQueue - Manual Home of Manuel PHP Contents Haut

Class synopsis

SplPriorityQueue implements Iterator , Countable {

/* Methods */

public __construct ( void )

public compare ( mixed $priority1 , mixed $priority2 ) : int

public count ( void ) : int

public current ( void ) : mixed

public extract ( void ) : mixed

public getExtractFlags ( void ) : int

public insert ( mixed $value , mixed $priority ) : bool

public isCorrupted ( void ) : bool

public isEmpty ( void ) : bool

public key ( void ) : mixed

public next ( void ) : void

public recoverFromCorruption ( void ) : void

public rewind ( void ) : void

public setExtractFlags ( int $flags ) : void

public top ( void ) : mixed

public valid ( void ) : bool

}

PHP: SplPriorityQueue - Manual Home of Manuel PHP Contents Haut

SplPriorityQueue::compare — Compare priorities in order to place elements correctly in the heap while sifting up
SplPriorityQueue::__construct — Constructs a new empty queue
SplPriorityQueue::count — Counts the number of elements in the queue
SplPriorityQueue::current — Return current node pointed by the iterator
SplPriorityQueue::extract — Extracts a node from top of the heap and sift up
SplPriorityQueue::getExtractFlags — Get the flags of extraction
SplPriorityQueue::insert — Inserts an element in the queue by sifting it up
SplPriorityQueue::isCorrupted — Tells if the priority queue is in a corrupted state
SplPriorityQueue::isEmpty — Checks whether the queue is empty
SplPriorityQueue::key — Return current node index
SplPriorityQueue::next — Move to the next node
SplPriorityQueue::recoverFromCorruption — Recover from the corrupted state and allow further actions on the queue
SplPriorityQueue::rewind — Rewind iterator back to the start (no-op)
SplPriorityQueue::setExtractFlags — Sets the mode of extraction
SplPriorityQueue::top — Peeks at the node from the top of the queue
SplPriorityQueue::valid — Check whether the queue contains more nodes

Find a PHP function

English translation

You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.

If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.

Thank you in advance.

Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-class.splpriorityqueue.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel PHP : http://php.net

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut

The SplPriorityQueue class

Introduction

Class synopsis

Table of Contents

References