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

compareメソッドは、SplHeapクラスに属し、ヒープデータ構造内の要素の順序を決定するために実装する抽象メソッドです。SplHeapは、PHPで優先度に基づいて要素を管理するヒープ構造を扱うための抽象クラスです。このcompareメソッドは、SplHeapを継承して独自のヒープクラスを作成する際に、必ずオーバーライドして比較ロジックを実装する必要があります。

このメソッドは、比較対象となる2つの要素 $value1 と $value2 を引数として受け取ります。そして、$value1 が $value2 よりも大きい場合は正の整数を、小さい場合は負の整数を、等しい場合は0を返すように実装します。この戻り値によって、ヒープが最小の要素を常に上位に置く「最小ヒープ」として機能するのか、あるいは最大の要素を常に上位に置く「最大ヒープ」として機能するのかが決まります。

したがって、compareメソッドは、ヒープ内部での要素の並び順を定義し、ヒープ全体の挙動を制御する重要な役割を担います。システムエンジニアを目指す方にとって、このメソッドを適切に実装することは、独自の優先順位付けに基づいたカスタムヒープを柔軟に構築し、データ処理の効率化を図る上で不可欠な知識となります。

Copy
1<?php
2// SplHeap クラスの compare メソッドは抽象メソッドであり、
3// SplHeap を継承するクラスで実装する必要があります。
4// このメソッドは、ヒープ内で2つの要素の順序を決定するために使用されます。
5//
6// 戻り値の規則は以下の通りです。
7// - value1 が value2 より小さい場合は負の整数を返す
8// - value1 が value2 と等しい場合は 0 を返す
9// - value1 が value2 より大きい場合は正の整数を返す
10//
11// SplHeap はこの戻り値に基づいて、正の値を返した場合に value1 をより高い優先度として扱います。
12// 以下の例は、数値の大小を比較し、最も大きい値が優先される（最大ヒープ）ような実装です。
13
14class MyMaxHeap extends SplHeap
15{
16    protected function compare(mixed $value1, mixed $value2): int
17    {
18        // 宇宙船演算子 (<=>) は、左辺が右辺より小さい場合は -1、
19        // 等しい場合は 0、大きい場合は 1 を返します。
20        // これにより、大きい値が優先される最大ヒープとして機能します。
21        return $value1 <=> $value2;
22    }
23}

mixed $value1, mixed $value2

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

int

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