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

Copy
1<?php
2
3// SplMinHeap を継承して、数値を比較するためのカスタムヒープを定義します。
4// SplMinHeap は抽象クラス SplHeap を継承しており、最小値が常に「現在の」要素になります。
5class MyMinHeap extends SplMinHeap
6{
7    /**
8     * 要素の比較ロジックを定義します。
9     * 親クラスの抽象メソッドを実装する必要があります。
10     *
11     * @param mixed $value1 比較する最初の値
12     * @param mixed $value2 比較する2番目の値
13     * @return int value1がvalue2より小さい場合は正の数、等しい場合は0、大きい場合は負の数を返します。
14     */
15    protected function compare(mixed $value1, mixed $value2): int
16    {
17        // SplMinHeapでは最小値がルート（トップ）になるため、
18        // value1がvalue2より小さい場合に、value1の「優先度が高い」と判断されるようにします。
19        // 結果が負の場合、value1はvalue2よりも優先度が低い（ヒープの下層へ）
20        // 結果が正の場合、value1はvalue2よりも優先度が高い（ヒープの上層へ）
21        // return $value1 <=> $value2; の場合、大きい方が「優先度が高い」となるため、
22        // 最小値がルートになるように $value2 <=> $value1 を使用します。
23        return $value2 <=> $value1;
24    }
25}
26
27/**
28 * SplHeap::current() メソッドの使用例を示します。
29 * SplHeap クラスの current() メソッドは、ヒープの最上位要素（この場合は最小値）を返します。
30 * キーワードの 'current' は、この「現在の要素」を指します。
31 */
32function demonstrateSplHeapCurrent(): void
33{
34    echo "SplHeap::current() メソッドのデモンストレーション:\n";
35
36    // MyMinHeap のインスタンスを作成します。
37    $heap = new MyMinHeap();
38
39    // ヒープに要素を追加します。
40    echo "要素をヒープに追加します: 5, 2, 8, 1\n";
41    $heap->insert(5);
42    $heap->insert(2);
43    $heap->insert(8);
44    $heap->insert(1); // これが最も小さい要素になります。
45
46    // ヒープが空でないことを確認します。
47    if ($heap->isEmpty()) {
48        echo "ヒープは空です。\n";
49        return;
50    }
51
52    // SplHeap::current() を使用して、現在の要素（この場合は最小値）を取得します。
53    // SplMinHeap では、ヒープの最上位（ルート）が常に最小値です。
54    echo "現在の要素 (SplHeap::current()): " . $heap->current() . " (最小値 '1' が期待されます)\n";
55
56    // 最上位の要素を取り出します (最小値 '1' がヒープから削除され、ヒープが再構築されます)。
57    echo "最上位の要素を取り出します (extract): " . $heap->extract() . "\n";
58
59    // 要素が取り出された後、SplHeap::current() を再度呼び出して、新しい現在の要素を確認します。
60    // 次に小さい値 '2' が最上位に来ます。
61    echo "要素取り出し後の現在の要素 (SplHeap::current()): " . $heap->current() . " (新しい最小値 '2' が期待されます)\n";
62
63    // さらに要素を取り出します。
64    echo "最上位の要素を取り出します (extract): " . $heap->extract() . "\n";
65
66    // 残りの要素での現在の要素を確認します。
67    echo "要素取り出し後の現在の要素 (SplHeap::current()): " . $heap->current() . " (新しい最小値 '5' が期待されます)\n";
68}
69
70// 関数を実行します。
71demonstrateSplHeapCurrent();
72

SplHeapは、PHPが提供する、要素を優先度に基づいて管理する「ヒープ」という特殊なデータ構造を扱うための抽象クラスです。SplHeap::current()メソッドは、ヒープの「最上位」にある要素を、ヒープから削除せずに取得するために使用します。このメソッドに引数はなく、ヒープに格納された様々な型の値をmixed型で返します。

サンプルコードでは、SplMinHeapを継承したMyMinHeapクラスを作成しています。SplMinHeapは、常に最小値がヒープの最上位に来るように要素を管理します。compareメソッドを実装することで、数値の大小関係に基づいて優先度を定義しています。

まず、ヒープに「5, 2, 8, 1」という数値を追加すると、最も小さい値である「1」がヒープの最上位に配置されます。ここで$heap->current()を呼び出すと、「1」が返され、ヒープの現在の最小値を確認できます。

次に$heap->extract()メソッドで「1」を取り出すと、ヒープは「1」を削除し、残りの要素から次の最小値である「2」を新しい最上位に再配置します。その後再び$heap->current()を呼び出すと、「2」が返され、ヒープの状態が更新されたことがわかります。current()メソッドは、ヒープの最上位要素を手軽に確認する際に利用されます。

Copy
1<?php
2
3/**
4 * SplMaxHeap を使用してタイムスタンプを管理し、
5 * 最も新しいタイムスタンプを常に参照する例です。
6 *
7 * SplMaxHeap は、要素を比較し、最大の要素をヒープの最上位（ルート）に維持する優先度付きキューです。
8 * current() メソッドは、ヒープの最上位にある要素を返します。
9 *
10 * このサンプルでは、複数のイベント発生時刻（タイムスタンプ）をヒープに追加し、
11 * その中で最も新しい発生時刻を current() で取得します。
12 * キーワード「php current timestamp」に対応するため、ヒープの最上位要素が
13 * 「現在の（最も新しい）タイムスタンプ」であると解釈できるシナリオを提供します。
14 */
15class TimestampMaxHeap extends SplMaxHeap
16{
17    // SplMaxHeap は数値の比較をデフォルトで適切に処理するため、
18    // このクラスでは compare メソッドをオーバーライドする必要はありません。
19    // このクラスは、タイムスタンプを管理するヒープとして意味付けするために定義されています。
20}
21
22// タイムスタンプを管理するヒープを作成
23$timestampHeap = new TimestampMaxHeap();
24
25// ダミーのイベント発生タイムスタンプをいくつか追加
26// 意図的に順番を前後させて、ヒープが正しく最大のタイムスタンプを管理することを示します。
27$timestampHeap->insert(time() - 3600); // 1時間前のタイムスタンプ
28$timestampHeap->insert(time() - 7200); // 2時間前のタイムスタンプ
29$timestampHeap->insert(time());       // 現在のタイムスタンプ
30$timestampHeap->insert(time() - 1800); // 30分前のタイムスタンプ
31
32echo "ヒープに複数のタイムスタンプを追加しました。\n";
33echo "SplMaxHeap の性質上、ヒープの最上位には最も新しいタイムスタンプが保持されています。\n";
34
35// SplHeap::current() メソッドを使用して、ヒープの最上位要素（最も新しいタイムスタンプ）を取得
36if (!$timestampHeap->isEmpty()) {
37    $currentTimestamp = $timestampHeap->current();
38
39    echo "取得されたタイムスタンプ（UNIX形式）: " . $currentTimestamp . "\n";
40    echo "取得されたタイムスタンプ（読みやすい形式）: " . date('Y-m-d H:i:s', $currentTimestamp) . "\n";
41} else {
42    echo "ヒープは空です。\n";
43}
44

PHP 8のSplHeapクラスは、要素を特定の優先度に基づいて管理する「ヒープ」というデータ構造を提供します。特にSplMaxHeapは、追加された要素の中から常に最大の要素をヒープの最上位に維持する特性を持つ優先度付きキューです。

SplHeap::current()メソッドは、このヒープの最上位に位置する要素を返すために使用されます。このメソッドは引数を必要とせず、ヒープが空でない限り、いつでも現在の最大の要素にアクセスできます。戻り値はmixed型で、ヒープに格納された任意の型の要素を返します。

サンプルコードでは、SplMaxHeapを継承したTimestampMaxHeapクラスを使用し、複数のタイムスタンプを管理しています。SplMaxHeapの性質により、追加されたタイムスタンプの中で最も新しい（つまり最も大きい）タイムスタンプが自動的に最上位に保持されます。その後、current()メソッドを呼び出すことで、この最も新しいタイムスタンプを簡単に取得しています。これにより、「現在のタイムスタンプ」として最も新しいイベント時刻を参照するシナリオを実現し、プログラムが最新の状態を追跡するのに役立ちます。