PHP マニュアル: 要素を比較し、ヒープ内の適切な位置に置く

説明

protected int SplHeap::compare(mixed $value1, mixed $value2)

value1 と value2 を比較します。

警告

SplHeap::compare 内で例外がスローされると、ヒープが壊れてしまいブロックされた状態になることがあります。 SplHeap::recoverFromCorruption をコールすればブロック状態を解除することができます。しかし、適切な場所に配置されていない要素が出てくることもあり、ヒープの性質が失われてしまいます。

パラメータ

value1: 比較したい最初のノード。
value2: 比較したい 2 番目のノード。

戻り値

比較結果を返します。value1 が value2 より大きい場合は正の整数値、等しい場合は 0、小さい場合は負の整数値となります。

注意:
同一の値を持つ複数の要素をヒープ内に保持することはおすすめしません。そうすると、ヒープ内の相対位置がはっきりしなくなってしまいます。