【PHP8.x】SplMaxHeap::compare()メソッドの使い方

compareメソッドは、PHPのSplMaxHeapクラスにおいて、ヒープ内の要素間の順序を決定するための比較ロジックを実行するメソッドです。SplMaxHeapは、常に最大値を持つ要素を効率的に取り出せるように設計された「最大ヒープ」というデータ構造を表します。このヒープがどの要素を「最大」と見なすかを判断する際に、このcompareメソッドが利用されます。

具体的には、このメソッドは2つの要素（$value1と$value2）を引数として受け取り、それらを比較して整数値を返します。$value1が$value2よりも大きいと判断される場合は正の整数を、$value1が$value2よりも小さいと判断される場合は負の整数を、そして両者が等しいと判断される場合はゼロを返します。SplMaxHeapは、この戻り値に基づいて要素の相対的な位置を決定し、ヒープ構造を適切に維持します。

デフォルトでは、数値や文字列などの標準的な比較が行われますが、開発者がSplMaxHeapを継承して独自のヒープクラスを作成する際に、このcompareメソッドをオーバーライド（上書き）することができます。これにより、例えばカスタムオブジェクトの特定のプロパティを基準に比較したり、独自の複雑なルールに基づいて要素の大小を定義したりすることが可能になります。この柔軟性により、様々なデータ型や要件に合わせた最大ヒープを効率的に実装できます。

Copy
1<?php
2
3class MyCustomMaxHeap extends SplMaxHeap
4{
5    /**
6     * 2つの値を比較し、最大ヒープにおける要素の順序を決定します。
7     * $value1 が $value2 よりも大きい（優先される）場合に正の値を返します。
8     *
9     * @param mixed $value1 比較対象の最初の値
10     * @param mixed $value2 比較対象の2番目の値
11     * @return int $value1 が $value2 より大きい場合は正、小さい場合は負、等しい場合は0
12     */
13    protected function compare(mixed $value1, mixed $value2): int
14    {
15        // ここに独自の比較ロジックを実装します。
16        // 例: 数値を比較し、大きい方を優先する場合
17        return $value1 <=> $value2;
18    }
19}

mixed $value1, mixed $value2

PHP:

• mixed $value1: 比較対象となる最初の値
• mixed $value2: 比較対象となる2番目の値

int

SplMaxHeap::compare メソッドは、2つの要素の比較結果を整数で返します。 返り値は、最初の要素が2番目の要素より大きい場合は正の値、等しい場合は0、小さい場合は負の値となります。