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

Copy
1<?php
2
3/**
4 * SplMaxHeap クラスの current() メソッドの使用例を示します。
5 * SplMaxHeap は最大ヒープを実装しており、current() メソッドはヒープの最大値（ルート要素）を返します。
6 * このコードは、ヒープへの要素の追加と、現在の最大値の取得を示しています。
7 */
8function demonstrateSplMaxHeapCurrent(): void
9{
10    // SplMaxHeap のインスタンスを作成します。
11    // これは、常に最大値がルートにあるヒープを維持します。
12    $maxHeap = new SplMaxHeap();
13
14    echo "--- SplMaxHeap::current() の使用例 ---\n";
15
16    // ヒープに要素を追加します。
17    // SplHeap を継承するクラスでは、insert() メソッドで要素を追加します。
18    $maxHeap->insert(10);
19    $maxHeap->insert(50);
20    $maxHeap->insert(20);
21    $maxHeap->insert(80);
22    $maxHeap->insert(30);
23
24    echo "ヒープに要素を追加しました: [10, 50, 20, 80, 30]\n";
25
26    // current() メソッドを使用して、ヒープの現在の最大値を取得します。
27    // SplMaxHeap では、常に最大要素が現在の要素となります。
28    if (!$maxHeap->isEmpty()) {
29        $currentMax = $maxHeap->current();
30        echo "現在の最大値 (current()): " . $currentMax . "\n"; // 例: 80
31    } else {
32        echo "ヒープは空です。\n";
33    }
34
35    // 最大要素をヒープから取り出します (extract)。
36    // これにより、次の最大値が新しい現在の要素になります。
37    if (!$maxHeap->isEmpty()) {
38        $extractedValue = $maxHeap->extract();
39        echo "最大値を取り出しました (extract()): " . $extractedValue . "\n"; // 例: 80
40    } else {
41        echo "ヒープが空のため、要素を取り出せません。\n";
42    }
43
44    // 再度 current() メソッドを使用して、取り出し後の新しい最大値を取得します。
45    if (!$maxHeap->isEmpty()) {
46        $currentMaxAfterExtract = $maxHeap->current();
47        echo "取り出し後の現在の最大値 (current()): " . $currentMaxAfterExtract . "\n"; // 例: 50
48    } else {
49        echo "ヒープは空です。\n";
50    }
51
52    // ヒープが空の場合の current() の動作を確認します。
53    // すべての要素をヒープから取り出します。
54    while (!$maxHeap->isEmpty()) {
55        $maxHeap->extract();
56    }
57    echo "すべての要素を取り出しました。ヒープは空です。\n";
58
59    // PHP 8 以降では、空のヒープで current() を呼び出すと false を返します。
60    $emptyHeapCurrent = $maxHeap->current();
61    if ($emptyHeapCurrent === false) {
62         echo "空のヒープでの current() は false を返しました。\n";
63    } else {
64         echo "空のヒープでの current() の結果: " . var_export($emptyHeapCurrent, true) . "\n";
65    }
66
67    echo "--- サンプル終了 ---\n";
68}
69
70// 関数を実行します。
71demonstrateSplMaxHeapCurrent();

PHP 8で利用できるSplMaxHeap::current()メソッドは、最大ヒープ（SplMaxHeap）に格納されている要素の中で、現在の最大値（ルート要素）を取得するために使用されます。SplMaxHeapは、常に最大の要素がヒープの最上位に位置するように自動的に管理される特殊なデータ構造です。

このcurrent()メソッドは引数を一切取らず、戻り値としてヒープ内の現在の最大値をmixed型で返します。サンプルコードでは、まずinsert()メソッドで複数の数値をヒープに追加しています。その後current()を呼び出すと、追加された「10, 50, 20, 80, 30」の中から最大の「80」が取得されることが確認できます。

extract()メソッドで現在の最大値（80）を取り除いた後、再度current()を呼び出すと、残りの要素の中から次に大きい「50」が新たな最大値として取得される挙動も示されています。このように、current()はヒープの最新の状態に基づき、常に最大の要素を参照する機能を提供します。PHP 8では、ヒープが空の状態でcurrent()を呼び出した場合、戻り値はfalseとなりますので、注意して利用してください。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * SplMaxHeap::current() メソッドの使用例。
7 *
8 * この関数は、SplMaxHeap（最大ヒープ）にタイムスタンプを追加し、
9 * その中から最も新しい（最大の）タイムスタンプを効率的に取得する方法を示します。
10 * システムエンジニアの初心者にとって、イベントの優先順位付けやログの最新エントリ追跡など、
11 * 時間ベースのデータを扱う際の基本を理解するのに役立ちます。
12 */
13function demonstrateSplMaxHeapCurrentWithTimestamps(): void
14{
15    echo "--- SplMaxHeap を使った最新タイムスタンプの追跡 ---" . PHP_EOL;
16
17    // SplMaxHeap を初期化します。
18    // SplMaxHeap は、追加された要素の中から常に最大の要素をトップに保持するデータ構造です。
19    // current() メソッドは、この最大要素（一番上の要素）をヒープから削除せずに参照するために使用されます。
20    $heap = new SplMaxHeap();
21
22    // 現在のUNIXタイムスタンプ（秒）を取得してヒープに追加します。
23    // time() は現在のシステム時刻を整数で返します。
24    $timestamp1 = time();
25    $heap->insert($timestamp1);
26    echo "追加されたタイムスタンプ: " . date('Y-m-d H:i:s', $timestamp1) . " (UNIX: $timestamp1)" . PHP_EOL;
27
28    // 少し時間を置いて、別のタイムスタンプを追加します。
29    // これにより、新しいタイムスタンプが古いものより大きくなります。
30    sleep(1); // 1秒待機
31    $timestamp2 = time();
32    $heap->insert($timestamp2);
33    echo "追加されたタイムスタンプ: " . date('Y-m-d H:i:s', $timestamp2) . " (UNIX: $timestamp2)" . PHP_EOL;
34
35    // SplMaxHeap::current() を使用して、ヒープ内の現在の最大値（最も新しいタイムスタンプ）を取得します。
36    // current() は要素をヒープから「取り出す」のではなく、「参照」するだけなので、
37    // ヒープの状態は変化しません。
38    if (!$heap->isEmpty()) {
39        $currentMaxTimestamp = $heap->current();
40        echo "現在ヒープのトップにある最新タイムスタンプ (current() で参照): " . date('Y-m-d H:i:s', (int)$currentMaxTimestamp) . " (UNIX: $currentMaxTimestamp)" . PHP_EOL;
41        // この時点で、timestamp2 が最新であるため、current() は timestamp2 を返します。
42    } else {
43        echo "ヒープは空です。" . PHP_EOL;
44    }
45
46    // さらに別のタイムスタンプを追加します。
47    sleep(1); // 1秒待機
48    $timestamp3 = time();
49    $heap->insert($timestamp3);
50    echo "追加されたタイムスタンプ: " . date('Y-m-d H:i:s', $timestamp3) . " (UNIX: $timestamp3)" . PHP_EOL;
51
52    // もう一度 current() を呼び出して、最大値が更新されたことを確認します。
53    if (!$heap->isEmpty()) {
54        $currentMaxTimestamp = $heap->current();
55        echo "更新後、現在ヒープのトップにある最新タイムスタンプ (current() で参照): " . date('Y-m-d H:i:s', (int)$currentMaxTimestamp) . " (UNIX: $currentMaxTimestamp)" . PHP_EOL;
56        // 新しく追加された timestamp3 が最も大きいため、current() は timestamp3 を返します。
57    } else {
58        echo "ヒープは空です。" . PHP_EOL;
59    }
60
61    echo PHP_EOL;
62    echo "--- ヒープから要素を取り出す (extract) ---" . PHP_EOL;
63    // 参考: ヒープから要素を「取り出す」場合は extract() (または pop() エイリアス) を使用します。
64    // extract() は最大の要素を返し、ヒープからその要素を削除します。
65    while (!$heap->isEmpty()) {
66        $extractedTimestamp = $heap->extract();
67        echo "ヒープから取り出したタイムスタンプ: " . date('Y-m-d H:i:s', (int)$extractedTimestamp) . " (UNIX: $extractedTimestamp)" . PHP_EOL;
68        if (!$heap->isEmpty()) {
69            echo "取り出し後、次に最新のタイムスタンプ (current() で参照): " . date('Y-m-d H:i:s', (int)$heap->current()) . " (UNIX: " . $heap->current() . ")" . PHP_EOL;
70        }
71    }
72    echo "ヒープは空になりました。" . PHP_EOL;
73}
74
75// 関数を実行して動作を確認します。
76demonstrateSplMaxHeapCurrentWithTimestamps();

SplMaxHeap::current()は、PHPのSplMaxHeapクラスに属するメソッドです。SplMaxHeapは、追加された要素の中から常に最大の要素を効率的に取得できる特殊なデータ構造（最大ヒープ）を提供します。

このcurrent()メソッドは、ヒープ内に現在存在する要素の中で最大のものを参照するために使用されます。引数はなく、ヒープのトップに位置する最大の要素をmixed型で返します。重要な点として、このメソッドは要素をヒープから削除するのではなく、その値を読み取るだけであるため、ヒープの状態は変化しません。

サンプルコードでは、SplMaxHeapにUNIXタイムスタンプを複数追加し、current()メソッドを使ってその時点で最も新しい（最も大きな）タイムスタンプを効率的に取得する様子を示しています。time()関数で現在のタイムスタンプを取得し、insert()でヒープに追加した後、current()を呼び出すことで、常に最新のタイムスタンプが参照できることを確認できます。これにより、イベントの優先順位付けやログの最新エントリ追跡といったシステム開発の場面で、時間ベースのデータを扱う際の基本が理解しやすくなります。ヒープから要素を削除したい場合は、extract()メソッドを使用します。