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

Copy
1<?php
2
3/**
4 * SplMaxHeap の rewind メソッドの動作を示すサンプルコードです。
5 *
6 * SplMaxHeap は、イテレータが巻き戻し可能であり、rewind() メソッドを使用することで、
7 * イテレータを最初の状態に戻して再度要素を走査できることを実演します。
8 *
9 * 最大ヒープなので、イテレートすると最大値から順に要素が取り出されます。
10 * キーワード: php rewindable generator (ここでは SplMaxHeap がrewindableなイテレータである点を強調)
11 */
12function demonstrateSplMaxHeapRewind(): void
13{
14    // SplMaxHeap のインスタンスを作成
15    $maxHeap = new SplMaxHeap();
16
17    // ヒープに要素を追加します。
18    echo "--- 要素を追加 ---\n";
19    $maxHeap->insert(10);
20    $maxHeap->insert(5);
21    $maxHeap->insert(20);
22    $maxHeap->insert(15);
23    echo "ヒープの現在の要素数: " . $maxHeap->count() . "\n\n";
24
25    // 最初のイテレーション: ヒープから最大値から順に要素を取り出して出力します。
26    // このイテレーションでは、ヒープから要素は削除されません。
27    echo "--- 最初のイテレーション (最大値から順に表示) ---\n";
28    foreach ($maxHeap as $value) {
29        echo "取り出した値: " . $value . "\n";
30    }
31    echo "最初のイテレーション後の要素数: " . $maxHeap->count() . "\n\n"; // 要素数は変わっていない
32
33    // rewind() メソッドを呼び出し、イテレータを先頭に巻き戻します。
34    // これにより、再度最初から要素を走査できるようになります。
35    echo "--- rewind() メソッドを呼び出し、イテレータを巻き戻します ---\n\n";
36    $maxHeap->rewind();
37
38    // 2回目のイテレーション: 巻き戻しを行ったため、再び最大値から順に要素が出力されます。
39    echo "--- 2回目のイテレーション (巻き戻し後、再度最大値から順に表示) ---\n";
40    foreach ($maxHeap as $value) {
41        echo "再び取り出した値: " . $value . "\n";
42    }
43    echo "2回目のイテレーション後の要素数: " . $maxHeap->count() . "\n\n";
44
45    echo "デモンストレーション終了。\n";
46}
47
48// 関数を実行します。
49demonstrateSplMaxHeapRewind();
50
51?>

PHP 8のSplMaxHeapクラスに属するrewindメソッドは、引数を持たず、戻り値もありません。このメソッドは、SplMaxHeapの内部イテレータを初期状態に「巻き戻す」役割を持っています。

SplMaxHeapは、追加された要素の中から常に最大の値を効率的に取り出せるデータ構造であり、イテレートすると最大値から順に要素が提供されます。foreach文などでこのヒープの要素を順に走査すると、イテレータの位置は進みますが、ヒープ内の要素自体は削除されません。

一度イテレーションを完了した後、再度最初から同じ要素群を最大値の順に走査したい場合にrewindメソッドが役立ちます。このメソッドを呼び出すことで、イテレータの内部状態がリセットされ、再び最初の要素（現在の最大値）から走査を開始できるようになります。これにより、SplMaxHeapは「巻き戻し可能（rewindable）」なイテレータとして、同じデータセットを複数回処理する際にも非常に便利に利用できます。

Copy
1<?php
2
3/**
4 * SplMaxHeap クラスの rewind メソッドの動作を示すサンプルコード。
5 * SplMaxHeap のイテレータは破壊的であるため、一度イテレートするとヒープは空になります。
6 */
7function demonstrateSplMaxHeapRewind(): void
8{
9    // SplMaxHeap のインスタンスを作成
10    $heap = new SplMaxHeap();
11
12    // ヒープに要素を挿入 (比較可能な数値を使用)
13    // SplMaxHeap は内部的に要素を比較し、常に最大値がトップに来るように管理します。
14    $heap->insert(30);
15    $heap->insert(10);
16    $heap->insert(50);
17    $heap->insert(20);
18    $heap->insert(40);
19
20    echo "--- 最初のイテレーション (最大値から順に要素が取り出されます) ---\n";
21    // SplMaxHeap のイテレータは破壊的です。
22    // foreach ループで要素が内部的に extract() され、ヒープから消費されます。
23    foreach ($heap as $item) {
24        echo "取り出した要素: " . $item . "\n";
25    }
26    echo "最初のイテレーション後、ヒープは空になります。\n\n";
27
28    // rewind() メソッドを呼び出します。
29    // これはイテレータの内部ポインタをリセットする役割がありますが、
30    // SplMaxHeap の場合、要素はすでに消費されているため、実質的な効果はありません。
31    $heap->rewind();
32    echo "rewind() を呼び出しました。\n\n";
33
34    echo "--- 2回目のイテレーション (ヒープは空なので何も出力されません) ---\n";
35    $count = 0;
36    foreach ($heap as $item) {
37        echo "取り出した要素: " . $item . "\n";
38        $count++;
39    }
40
41    if ($count === 0) {
42        echo "2回目のイテレーションでは、ヒープが空のため何も要素がありませんでした。\n";
43    }
44    echo "SplMaxHeap のイテレータは破壊的であるため、\n";
45    echo "一度イテレートすると要素は失われ、rewind() を呼び出しても元の要素は戻りません。\n";
46}
47
48// 関数を実行してデモンストレーションを開始
49demonstrateSplMaxHeapRewind();

PHP 8のSplMaxHeapクラスは、常に最大値が先頭に来るように要素を管理する「最大ヒープ」と呼ばれるデータ構造を提供します。このクラスのrewindメソッドは、ヒープのイテレータの内部ポインタを初期位置（先頭）にリセットするために使用されます。このメソッドは引数を取らず、戻り値もありません。

しかし、SplMaxHeapのイテレータには重要な特性があります。それは「破壊的である」という点です。つまり、foreachループなどでヒープの要素を順に取り出すと、その要素はヒープ本体から削除されてしまいます。一度要素が取り出されてヒープが空になると、rewindメソッドを呼び出しても、すでに失われた要素がヒープに戻ることはありません。

提供されたサンプルコードでは、まずSplMaxHeapに複数の数値を挿入します。最初のforeachループで要素を順に表示すると、ヒープは最大値から順に要素を取り出し、最終的に空になります。その後、rewind()メソッドを呼び出しますが、ヒープはすでに空であるため、二度目のforeachループでは何も要素が取り出されないことが確認できます。これは、SplMaxHeapのイテレータが破壊的であり、一度消費された要素はrewindでは復元されないことを明確に示しています。したがって、SplMaxHeapではrewindメソッドを呼び出しても、実質的な効果は期待できません。