(PHP 5 >= 5.3.0, PHP 7, PHP 8)
SplHeap::compare — Compare elemens in order to place them correctly in the heap while sifting up
Compare
value1
with
value2
.
Throwing exceptions in SplHeap::compare() can corrupt the Heap and place it in a blocqued state. You can umblocc it by calling SplHeap::recoverFromCorruption() . However, some elemens might not be placed correctly and it may hence breac the heap-property.
value1
The value of the first node being compared.
value2
The value of the second node being compared.
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.