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

Copy
1<?php
2
3/**
4 * SplHeap の rewind メソッドの動作を示すサンプルコード。
5 *
6 * SplHeap は優先度キュー（ヒープ）を実装しており、イテレータとしても機能します。
7 * ただし、SplHeap は抽象クラスであるため、直接インスタンス化はできません。
8 * 通常は SplMinHeap (最小値優先) または SplMaxHeap (最大値優先) を使用します。
9 *
10 * 重要な注意点として、SplHeap のイテレータは要素を「消費」する特性があります。
11 * つまり、一度イテレートして要素を取り出すと、その要素はヒープから削除されます。
12 * そのため、rewind() を呼び出しても、既にヒープから取り出された要素はヒープには戻りません。
13 * rewind() は、イテレータの内部ポインタを初期状態（ヒープの先頭）に戻すだけです。
14 *
15 * キーワード「php rewindable generator」との関連性:
16 * 通常のPHPジェネレータは一度値を生成しきると巻き戻すことができません。
17 * SplHeap はイテレータインターフェースを実装しており rewind() メソッドを持ちますが、
18 * 上述の「要素を消費する」特性のため、一般的な意味での「巻き戻し可能なイテレータ」とは
19 * 異なる挙動を示します。このサンプルでは、その特性を理解することが重要です。
20 */
21function demonstrateSplHeapRewind(): void
22{
23    echo "SplHeap::rewind メソッドのデモンストレーション:\n";
24
25    // SplMinHeap を使用します。これは SplHeap を継承し、最小要素を優先するヒープです。
26    $heap = new SplMinHeap();
27
28    // 要素をヒープに追加
29    $heap->insert(30);
30    $heap->insert(10);
31    $heap->insert(20);
32    $heap->insert(5); // 最も小さい値なので、最初に取得される
33
34    echo "\n--- 1回目のイテレーション (要素を消費します) ---\n";
35    echo "初期のヒープ内の要素数: " . $heap->count() . "\n";
36    echo "要素を取り出す順序 (最小値から):\n";
37    foreach ($heap as $item) {
38        echo "- " . $item . "\n";
39    }
40    echo "1回目のイテレーション後、ヒープは空になりました。\n";
41    echo "現在のヒープ内の要素数: " . $heap->count() . "\n";
42
43    // rewind メソッドを呼び出す
44    echo "\n--- rewind() を呼び出し ---\n";
45    $heap->rewind();
46    echo "rewind() が呼び出されました。\n";
47    echo "rewind() はイテレータの内部ポインタを初期状態に戻しますが、\n";
48    echo "ヒープから一度取り出された要素は戻りません。\n";
49    echo "現在のヒープ内の要素数: " . $heap->count() . " (ヒープはまだ空のままです)\n";
50
51    echo "\n--- 2回目のイテレーション (何も取り出されません) ---\n";
52    // 2回目のイテレーション
53    // ヒープは既に空なので、何も出力されません。
54    if ($heap->isEmpty()) {
55        echo "ヒープは空なので、2回目のイテレーションでは何も出力されません。\n";
56    }
57    foreach ($heap as $item) {
58        // このブロックはヒープが空のため実行されません
59        echo "取り出した要素 (2回目): " . $item . "\n";
60    }
61    echo "2回目のイテレーション終了。\n";
62}
63
64// サンプル関数を実行
65demonstrateSplHeapRewind();

SplHeapクラスのrewindメソッドは、ヒープをイテレータとして使用する際に、その内部ポインタを初期状態に巻き戻すためのメソッドです。このメソッドは引数を取らず、戻り値もありません。

サンプルコードでは、SplHeapを継承したSplMinHeapを使用しています。まず、いくつかの要素をヒープに追加し、最初のイテレーションでこれらの要素を最小値から順に取り出します。SplHeapのイテレータは要素を「消費」する特性があるため、一度取り出された要素はヒープから削除されます。このため、最初のイテレーションが完了すると、ヒープは空の状態になります。

次にrewindメソッドを呼び出しますが、このメソッドはイテレータの内部ポインタを先頭に戻すだけです。既にヒープから削除されて消費された要素が、rewindによってヒープに戻ることはありません。したがって、二度目のイテレーションを試みても、ヒープが空であるため何も取り出されません。

これは、通常のPHPジェネレータが一度値を生成しきると巻き戻せないのと同様に、SplHeapのrewindも、消費された要素を再利用する意味での「巻き戻し可能なイテレータ」とは異なる挙動を示す点に注意が必要です。rewindは、イテレーションを再開する際のポインタ位置をリセットする役割を果たしますが、ヒープの中身自体が元に戻るわけではないことを理解することが重要です。

Copy
1<?php
2
3/**
4 * SplHeap::rewind() メソッドの使用例。
5 *
6 * SplHeap は抽象クラスのため、具体的な実装である SplMinHeap を使用します。
7 * rewind() メソッドは、イテレータをヒープの先頭要素に巻き戻します。
8 * これにより、ヒープの要素を再度イテレートできるようになります。
9 */
10
11// SplMinHeap のインスタンスを作成（SplHeap を継承）
12$heap = new SplMinHeap();
13
14// ヒープに要素を追加
15$heap->insert(5);
16$heap->insert(1);
17$heap->insert(8);
18$heap->insert(3);
19$heap->insert(2);
20
21echo "--- 1回目のイテレーション（イテレータを消費） ---\n";
22// ヒープの要素を一度イテレートし、イテレータを終端に進めます。
23// SplMinHeap は最小要素から順に提供します。
24foreach ($heap as $item) {
25    echo "要素: " . $item . "\n";
26}
27// この時点でイテレータは終端に達しており、valid() は false を返します。
28
29echo "\n--- rewind() の呼び出し ---\n";
30echo "rewind() 呼び出し前、イテレータは有効か？: " . ($heap->valid() ? "はい" : "いいえ") . "\n";
31
32// rewind() メソッドを呼び出し、イテレータを先頭に巻き戻します。
33// このメソッドは引数を取らず、戻り値もありません。
34$heap->rewind();
35
36echo "rewind() 呼び出し後、イテレータは有効か？: " . ($heap->valid() ? "はい" : "いいえ") . "\n";
37
38// rewind() 後、イテレータは再び有効になり、先頭要素を指します。
39echo "rewind() 後、現在の要素: " . $heap->current() . "\n";
40
41echo "\n--- 2回目のイテレーション（rewind() 後） ---\n";
42// rewind() 後、再度ヒープをイテレートできることを示します。
43foreach ($heap as $item) {
44    echo "要素（rewind() 後）: " . $item . "\n";
45}
46
47?>

PHP 8で提供されるSplHeapクラスのrewind()メソッドは、ヒープ構造のイテレータを先頭要素に巻き戻すための機能です。SplHeapは抽象クラスであるため、具体的なヒープ操作を行う際は、その派生クラスであるSplMinHeapやSplMaxHeapなどを使用します。

このrewind()メソッドは、引数を一切取らず、戻り値もありません。主な役割は、ヒープの要素を一度foreachなどでイテレート（走査）し終えた後、再度最初からヒープの要素にアクセスしたい場合に、イテレータの位置をリセットすることです。

サンプルコードでは、まずSplMinHeapに複数の要素を追加し、一度foreachループでイテレートして要素を全て取り出しています。この時点でイテレータはヒープの終端に達し、それ以上要素を取り出すことはできません。そこでrewind()メソッドを呼び出すと、イテレータが自動的にヒープの最初の要素を指す位置に戻ります。これにより、再びforeachループを使用して、ヒープ内の全要素を最初から順に走査できるようになります。データ構造を繰り返し処理する際に非常に便利なメソッドです。