SplMaxHeap::compare

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

SplMaxHeap::compare — Compare elemens in order to place them correctly in the heap while sifting up

protected SplMaxHeap::compare ( mixed


         $value1

, mixed


         $value2

): int

Compare value1 with value2 .

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

Note :
Having multiple elemens with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.

-1

sixd at php dot net ¶

15 years ago

Note the definition of SplMaxHeap::compare() is different from SplMinHeap::compare()