The PriorityQueue class

(PECL ds >= 1.0.0)

Introduction

A PriorityQueue is very similar to a Queue. Values are pushed into the queue with an assigned priority, and the value with the highest priority will always be at the front of the queue.

Implemented using a max heap.

Note:
"First in, first out" ordering is preserved for values with the same priority.

Note:
Iterating over a PriorityQueue is destructive, equivalent to successive pop operations until the queue is empty.

Class synopsis

class Ds\PriorityQueue implements Ds\Collection {

/* Constants */

const int MIN_CAPACITY = 8;

/* Methods */

public function allocate(int $capacity): void

public function capacity(): int

public function clear(): void

public function copy(): Ds\PriorityQueue

public function isEmpty(): bool

public function peek(): mixed

public function pop(): mixed

public function push(mixed $value, int $priority): void

public function toArray(): array

}

Predefined Constants

Ds\PriorityQueue::MIN_CAPACITY

Ds\PriorityQueue::allocate — Allocates enough memory for a required capacity
Ds\PriorityQueue::capacity — Returns the current capacity
Ds\PriorityQueue::clear — Removes all values
Ds\PriorityQueue::__construct — Creates a new instance
Ds\PriorityQueue::copy — Returns a shallow copy of the queue
Ds\PriorityQueue::count — Returns the number of values in the queue
Ds\PriorityQueue::isEmpty — Returns whether the queue is empty
Ds\PriorityQueue::jsonSerialize — Returns a representation that can be converted to JSON
Ds\PriorityQueue::peek — Returns the value at the front of the queue
Ds\PriorityQueue::pop — Removes and returns the value with the highest priority
Ds\PriorityQueue::push — Pushes values into the queue
Ds\PriorityQueue::toArray — Converts the queue to an array

The PriorityQueue class

Introduction

Class synopsis

Predefined Constants

Table of Contents