PHP - PriorityQueue Functions

PriorityQueue is very similar to the Queue. The values are pushed into the queue with an assigned priority, and the value with the highest priority can always be at the front of the queue. It is implemented by using a max heap.

Requirements

PHP 7 is required for both extension and the compatibility polyfill.

Installation

The easiest way to install data structure by using the PECL extension.

pecl install ds

Syntax

public Ds\PriorityQueue::functionName()

Class Synopsis

Ds\PriorityQueue implements Ds\Collection {
   /* Constants */
   const int MIN_CAPACITY = 8 ;
   
   /* Methods */
   public void allocate( int $capacity )
   public int capacity( void )
   public void clear( void )
   public Ds\PriorityQueue copy( void )
   public bool isEmpty( void )
   public mixed peek( void )
   public mixed pop( void )
   public void push( mixed $value, int $priority )
   public array toArray( void )
}

Predefined Constants

Ds\PriorityQueue::MIN_CAPACITY

List of Functions

Here is the complete list of functions available in the PriorityQueue class −

Important Note

Here is the important point to keep in mind −

1. The "first in, first out" ordering is preserved for values with the same priority.
2. Iterating over a PriorityQueue destructively is equivalent to continuously running pop operations across the queue until it is empty.