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

Copy
1<?php
2
3/**
4 * SplMinHeap::current() メソッドの使用例をデモンストレーションします。
5 *
6 * SplMinHeap は最小ヒープデータ構造であり、ヒープ内の最小要素が常にトップに位置します。
7 * current() メソッドは、この最小要素をヒープから削除せずに取得します。
8 */
9function demonstrateSplMinHeapCurrent(): void
10{
11    echo "--- SplMinHeap を初期化 ---\n";
12    $minHeap = new SplMinHeap();
13
14    // ヒープに要素を挿入します。
15    // ヒープは自動的に要素を整理し、常に最小要素がトップにくるようにします。
16    $minHeap->insert(10);
17    $minHeap->insert(5);
18    $minHeap->insert(20);
19    $minHeap->insert(3);
20    $minHeap->insert(15);
21
22    echo "挿入された要素: 10, 5, 20, 3, 15\n\n";
23
24    // current() を使用して、ヒープから最小要素を削除せずに確認します。
25    // SplMinHeap の場合、current() と top() (SplHeap固有のメソッド) は同じ値を返します。
26    echo "--- current() を使用して最小要素を確認 ---\n";
27    if (!$minHeap->isEmpty()) {
28        $smallestElement = $minHeap->current();
29        echo "現在の（最小）ヒープ要素: " . $smallestElement . "\n"; // 期待値: 3
30        echo "current() 呼び出し後のヒープサイズ: " . $minHeap->count() . "\n\n"; // サイズは変更されず 5 のまま
31    } else {
32        echo "ヒープは空です。\n\n";
33    }
34
35    // 次に、最小要素を extract() します。これはヒープから要素を *削除* します。
36    echo "--- 最小要素を extract() ---\n";
37    if (!$minHeap->isEmpty()) {
38        $extractedElement = $minHeap->extract();
39        echo "抽出された要素: " . $extractedElement . "\n"; // 期待値: 3
40        echo "extract() 呼び出し後のヒープサイズ: " . $minHeap->count() . "\n\n"; // サイズは 4 になる
41    } else {
42        echo "ヒープが空のため抽出できません。\n";
43    }
44
45    // 抽出後、次に小さい要素が新しい「current」になります。
46    echo "--- 抽出後に再度 current() を確認 ---\n";
47    if (!$minHeap->isEmpty()) {
48        $newSmallestElement = $minHeap->current();
49        echo "新しい現在の（最小）ヒープ要素: " . $newSmallestElement . "\n"; // 期待値: 5
50        echo "current() 呼び出し後のヒープサイズ: " . $minHeap->count() . "\n\n"; // サイズは変更されず 4 のまま
51    } else {
52        echo "ヒープは現在空です。\n";
53    }
54
55    // foreach ループが SplMinHeap とどのように連携するかをデモンストレーションします。
56    // 注意: SplMinHeap を foreach で反復処理すると、要素を *抽出* していくため、
57    // 処理が進むにつれてヒープは空になります。各イテレーションは current() を呼び出して要素を取得し、
58    // その後 next() (extract() を呼び出す) を呼び出して次の要素に進みます。
59    echo "--- foreach (暗黙的に current() と extract() を使用) での反復処理 ---\n";
60    $iterationHeap = new SplMinHeap();
61    $iterationHeap->insert(7);
62    $iterationHeap->insert(1);
63    $iterationHeap->insert(9);
64    $iterationHeap->insert(4);
65
66    echo "新しいヒープに挿入された要素: 7, 1, 9, 4\n";
67    echo "反復処理前のヒープサイズ: " . $iterationHeap->count() . "\n";
68    echo "ヒープを反復処理中:\n";
69    foreach ($iterationHeap as $element) {
70        echo "  - 反復処理中に取得された要素: " . $element . "\n";
71    }
72    echo "反復処理後のヒープサイズ: " . $iterationHeap->count() . "\n"; // 期待値: 0
73    echo "反復処理後、ヒープは空か: " . ($iterationHeap->isEmpty() ? "true" : "false") . "\n";
74}
75
76// デモンストレーション関数を実行
77demonstrateSplMinHeapCurrent();

SplMinHeap::current()は、PHP 8で利用できるSplMinHeapクラスのメソッドです。SplMinHeapは、常に最も小さな要素を「トップ」（先頭）に保持する特殊なデータ構造である「最小ヒープ」を実装しています。このcurrent()メソッドは、引数を必要とせず、ヒープ内の現在最も小さいとされる要素の値をmixed型で返します。

このメソッドの最大の特徴は、対象の要素をヒープから削除せずにその値を取得できる点です。そのため、current()を何度呼び出しても、ヒープの要素数は変化しません。サンプルコードでは、SplMinHeapに複数の数値を挿入した後、current()を使って最小値が「3」であることを確認し、ヒープのサイズがそのまま維持される様子が示されています。

これに対し、extract()メソッドはヒープの最小要素を取り除きながら取得するため、ヒープの要素数が一つ減ります。サンプルコードでも、extract()の後にcurrent()を再度呼び出すと、削除された「3」の次に小さい「5」が新たな最小要素として取得されることが確認できます。また、SplMinHeapをforeachループで反復処理すると、各要素はcurrent()で取得され、その後extract()で削除されるため、ループ終了時にはヒープが空になります。current()は、ヒープ構造を壊すことなく、現在の最小要素を安全に参照したい場合に非常に便利な機能です。

Copy
1<?php
2
3/**
4 * SplMinHeapを使用してタイムスタンプを管理し、最も古いタイムスタンプを取得する例。
5 *
6 * SplMinHeap::current() メソッドは、ヒープの現在の（最小）要素を返します。
7 * この例では、複数のUNIXタイムスタンプをヒープに挿入し、
8 * その中で最も古いタイムスタンプ（最小値）を current() メソッドで取得します。
9 * これは「php current timestamp」というキーワードに対して、
10 * 複数のタイムスタンプから「現在の（最も古い）」タイムスタンプを取り出す方法として関連付けられます。
11 */
12function getEarliestTimestampFromHeap(): void
13{
14    // SplMinHeap のインスタンスを作成
15    // SplMinHeap は最小ヒープであり、current() は常に最小要素（この場合、最も小さいタイムスタンプ）を返します。
16    $timestampHeap = new SplMinHeap();
17
18    // 複数の異なるUNIXタイムスタンプをヒープに挿入
19    $currentTime = time(); // 現在のUNIXタイムスタンプ
20    $timestampHeap->insert($currentTime);           // 現在
21    $timestampHeap->insert($currentTime - 3600);    // 1時間前
22    $timestampHeap->insert($currentTime - 7200);    // 2時間前
23    $timestampHeap->insert($currentTime - 1800);    // 30分前
24
25    echo "--- 挿入されたタイムスタンプ（UNIX形式と日時形式）---\n";
26    echo "  現在のタイムスタンプ:     " . $currentTime . " (" . date('Y-m-d H:i:s', $currentTime) . ")\n";
27    echo "  1時間前のタイムスタンプ:  " . ($currentTime - 3600) . " (" . date('Y-m-d H:i:s', $currentTime - 3600) . ")\n";
28    echo "  2時間前のタイムスタンプ:  " . ($currentTime - 7200) . " (" . date('Y-m-d H:i:s', $currentTime - 7200) . ")\n";
29    echo "  30分前のタイムスタンプ:   " . ($currentTime - 1800) . " (" . date('Y-m-d H:i:s', $currentTime - 1800) . ")\n";
30    echo "\n";
31
32    // SplMinHeap の current() メソッドを使用して、ヒープの最小要素（最も古いタイムスタンプ）を取得します。
33    // SplMinHeap では、current() は常にヒープのトップ（最小要素）を指します。
34    $earliestTimestamp = $timestampHeap->current();
35
36    echo "--- SplMinHeap::current() で取得された最も古いタイムスタンプ ---\n";
37    echo "  UNIXタイムスタンプ: " . $earliestTimestamp . "\n";
38    echo "  日時形式: " . date('Y-m-d H:i:s', $earliestTimestamp) . "\n";
39}
40
41// 関数を実行し、結果を出力
42getEarliestTimestampFromHeap();
43

PHP 8のSplMinHeap::current()メソッドは、最小ヒープの「現在（最小）の要素」を参照するために使用されます。このメソッドは引数を取らず、ヒープの最上位にある最小要素をmixed型で返します。ヒープから要素を削除することなく、その値を確認できる点が特徴です。

このサンプルコードは、「php current timestamp」というキーワードに関連して、複数のUNIXタイムスタンプの中から最も古い、つまり最小のタイムスタンプを効率的に取得する方法を示しています。まず、SplMinHeapのインスタンスを作成し、現在の時刻やそれより過去の時刻を表す複数のUNIXタイムスタンプをinsert()メソッドで追加します。SplMinHeapは最小ヒープとして動作するため、要素が追加されると、常に最小値がヒープの最上位に配置されるように内部で自動的に管理されます。

その後、current()メソッドを呼び出すことで、ヒープ内に存在するすべてのタイムスタンプの中で、最も古い（最小値の）タイムスタンプを即座に取得できます。これは、複数のタイムスタンプ情報の中から「現在の状態における最も古いタイムスタンプ」を知りたい場合に非常に役立ちます。例えば、タスクのキュー管理で最も期限の近いタスクを特定する際などに応用可能です。このメソッドはヒープの要素を削除しないため、何度呼び出しても同じ最小値を返し続けます。