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

Copy
1<?php
2
3/**
4 * SplMinHeap::rewind() メソッドの動作をデモンストレーションします。
5 *
6 * SplMinHeap は、常に最小の要素を先頭に保つ特殊なヒープ（優先度キュー）です。
7 * PHP の Iterator インターフェースを実装しているため、foreach ループで要素を走査できます。
8 *
9 * rewind() メソッドは、このイテレータの内部ポインタを最初の位置に戻します。
10 * 通常、foreach ループは開始時に自動的に rewind() を呼び出してイテレータをリセットしますが、
11 * 複雑なイテレータ操作後に手動で走査位置をリセットしたい場合などに使用します。
12 */
13function demonstrateSplMinHeapRewind(): void
14{
15    echo "--- SplMinHeap::rewind() デモンストレーション ---" . PHP_EOL;
16
17    // 1. SplMinHeap のインスタンスを作成し、要素を追加
18    $heap = new SplMinHeap();
19    echo "ヒープに要素を追加: 30, 10, 50, 20, 40" . PHP_EOL;
20    $heap->insert(30);
21    $heap->insert(10);
22    $heap->insert(50);
23    $heap->insert(20);
24    $heap->insert(40);
25    echo "現在のヒープのサイズ: " . $heap->count() . PHP_EOL . PHP_EOL;
26
27    // 2. 最初のイテレーション: foreach で要素を走査
28    // SplMinHeap は最小の要素から順に取り出します。
29    // foreach ループは開始時に自動的に SplMinHeap::rewind() を呼び出します。
30    echo "1回目のイテレーション（最小値から順に取り出し）:" . PHP_EOL;
31    foreach ($heap as $item) {
32        echo "取得要素: " . $item . PHP_EOL;
33    }
34    echo "1回目のイテレーション完了。" . PHP_EOL . PHP_EOL;
35
36    // ここでイテレータの内部ポインタはすべての要素を走査し終えた状態にあります。
37    // もし明示的な rewind() なしで、foreach 以外の方法（例: $heap->current() など）で
38    // 再度要素にアクセスしようとすると、通常は要素が取得できません。
39
40    // 3. SplMinHeap::rewind() を呼び出してイテレータを先頭に巻き戻す
41    // このメソッドは、イテレータの現在位置をリセットし、再度最初から要素にアクセスできるようにします。
42    echo "SplMinHeap::rewind() を呼び出してイテレータを先頭に巻き戻します..." . PHP_EOL;
43    $heap->rewind();
44    echo "巻き戻し完了。" . PHP_EOL . PHP_EOL;
45
46    // 4. 2回目のイテレーション: 再度 foreach で要素を走査
47    // 上記の明示的な rewind()、またはこの foreach ループ開始時の自動 rewind() により、
48    // イテレータがリセットされ、再び最小要素から要素が取り出されます。
49    echo "2回目のイテレーション（rewind() 後、再度最小値から順に取り出し）:" . PHP_EOL;
50    foreach ($heap as $item) {
51        echo "取得要素: " . $item . PHP_EOL;
52    }
53    echo "2回目のイテレーション完了。" . PHP_EOL . PHP_EOL;
54
55    echo "--- デモンストレーション終了 ---" . PHP_EOL;
56}
57
58// 関数を実行して、SplMinHeap::rewind() の動作を確認します。
59demonstrateSplMinHeapRewind();

PHPのSplMinHeapクラスは、常に最小の要素を先頭に保つ特殊な「優先度キュー」を実現するものです。これは、複数のデータの中から常に最も小さい値を取り出したい場合に非常に便利です。

SplMinHeapはPHPのIteratorインターフェースを実装しているため、foreachループを使って格納された要素を順番に処理することができます。このとき、要素は内部的に管理されている優先度に基づき、常に最小値から順に取り出されます。

SplMinHeap::rewind()メソッドは、このイテレータの「内部ポインタ」を最初の位置にリセットする役割を持ちます。これにより、一度すべての要素を走査し終えてポインタが末尾にある状態からでも、再び最初から要素を取り出せるように準備ができます。このメソッドは引数を一切受け取らず、また、戻り値もありません。

通常、foreachループは開始時に自動的にrewind()メソッドを呼び出してイテレータをリセットするため、明示的にこのメソッドを呼び出す必要はほとんどありません。しかし、ループの途中で処理を中断したり、current()やnext()のようなメソッドを直接操作した後に、改めてイテレータの先頭から処理を再開したい場合に、手動でrewind()を呼び出すことでイテレータの状態をリセットし、再び要素を最初から走査できるようになります。サンプルコードでは、1回目のループ後にrewind()を呼び出すことで、2回目のループでも再び最小値から要素が取り出されることを示しています。

Copy
1<?php
2
3// SplMinHeap は、最小値が常に先頭に来るように要素を管理するデータ構造（最小ヒープ）です。
4// これは、複数の値を格納し、特定の順序で取り出したい場合に便利な「配列のような」コンテナと考えることができます。
5$heap = new SplMinHeap();
6
7// ヒープに要素を追加します。追加する順序に関わらず、最小の要素が先頭に保たれます。
8$heap->insert(10);
9$heap->insert(5);
10$heap->insert(20);
11$heap->insert(2);
12$heap->insert(15);
13
14echo "--- ヒープの要素を最初から取り出します（初回イテレーション）---\n";
15
16// SplMinHeap は Iterator インターフェースを実装しているため、foreach ループで要素を順に処理できます。
17// 最小ヒープなので、最小の要素から順に取り出されます。
18foreach ($heap as $value) {
19    echo "初回イテレーション: 取り出した要素 = " . $value . "\n";
20    if ($value === 5) {
21        // 例として、特定の要素が取り出された時点でイテレーションを中断します。
22        // これにより、まだヒープ内に要素が残った状態になります。
23        echo "初回イテレーション: 途中で処理を中断しました。\n";
24        break;
25    }
26}
27
28echo "--- rewind() メソッドを呼び出します ---\n";
29// rewind() メソッドは、イテレータの内部ポインタを最初の要素の位置に戻します。
30// これにより、再度ヒープの最初から要素を処理できるようになります。
31$heap->rewind();
32
33echo "--- rewind() 後、再度ヒープの要素を取り出します（2回目イテレーション）---\n";
34
35// rewind() の呼び出しにより、再度ヒープの最初（現在の最小要素）から要素を取り出せます。
36foreach ($heap as $value) {
37    echo "2回目イテレーション: 取り出した要素 = " . $value . "\n";
38}
39
40// 注意: SplMinHeap を foreach でイテレートすると、要素はヒープから取り出され（extract され）削除されます。
41// そのため、上記の2回のイテレーション後、ヒープは空になります。
42echo "ヒープが空になったか？ " . ($heap->isEmpty() ? "はい" : "いいえ") . "\n";
43
44?>

PHPのSplMinHeapクラスは、最小値が常に先頭に来るように要素を管理する特殊なデータ構造です。これは、複数の値を格納し、最小値から順に取り出したい場合に便利な「配列のような」コンテナと考えることができます。SplMinHeapは、foreachループなどで要素を順に処理できるIteratorインターフェースを実装しています。

SplMinHeap::rewind()メソッドは、このイテレータの内部ポインタを最初の要素の位置に戻す役割を持っています。このメソッドには引数がなく、戻り値もありません。

例えば、foreachループでSplMinHeapの要素を処理している途中でループを中断した場合、イテレータの内部ポインタは中断した位置に留まります。この状態で再度イテレーションを開始すると、中断した場所から処理が再開されます。しかし、rewind()メソッドを呼び出すことで、イテレータのポインタがリセットされ、もう一度ヒープの最小要素（最初の要素）から要素を取り出すことができるようになります。

サンプルコードでは、一度SplMinHeapのイテレーションを途中で中断した後、rewind()を呼び出すことで、再度最初から要素を取り出し直している様子が示されています。

なお、SplMinHeapをforeachでイテレートすると、要素はヒープから取り出されて削除される点に注意が必要です。