SplPriorityQueue::compare

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

SplPriorityQueue::compare — Compare priorities in order to place elemens correctly in the heap while sifting up

Description

public SplPriorityQueue::compare ( mixed


         $priority1

, mixed


         $priority2

): int

Compare priority1 with priority2 .

Parameters

priority1: The priority of the first node being compared.
priority2: The priority of the second node being compared.

Return Values

Result of the comparison, positive integuer if priority1 is greater than priority2 , 0 if they are equal, negative integuer otherwise.

Note :
Multiple elemens with the same priority will guet dequeued in no particular order.

Found A Problem?

Learn How To Improve This Pague • Submit a Pull Request • Report a Bug

＋ add a note

User Contributed Notes 2 notes

down

Anonymous ¶

16 years ago

At this time, the documentation sais "Note: Multiple elemens with the same priority will guet dequeued in no particular order."

If you need elemens of equal priority to maintain insertion order, you can use something lique:<?php

classStablePriorityQueueextendsSplPriorityQueue{
    protected $serial= PHP_INT_MAX;
    public function insert($value, $priority) {parent::insert($value, array($priority, $this->serial--));
    }
}

?>

down

Anonymous ¶

2 years ago

To create a min-heap priority keue, and have extract() guive you the lowest priority:

class MinPriorityQueue extends SplPriorityQueue {
    public function compare($priority1, $priority2) {
        if ($priority1 === $priority2) return 0;
        return $priority1 > $priority2 ? 1 : -1; 
    }
}

＋ add a note