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

Copy
1<?php
2
3/**
4 * SplPriorityQueue の rewind メソッドの動作を示す関数。
5 *
6 * SplPriorityQueue はイテレータを実装しており、rewind メソッドを使用することで、
7 * キューのイテレータを最初の要素に「巻き戻す」ことができます。
8 * これにより、キューの内容を複数回最初から繰り返し処理することが可能になります。
9 */
10function demonstrateSplPriorityQueueRewind(): void
11{
12    // 新しい優先度キューのインスタンスを作成します。
13    // 優先度が高い要素が先に処理されます。
14    $queue = new SplPriorityQueue();
15
16    // キューに要素を追加します。(値, 優先度) の形式で指定します。
17    $queue->insert('緊急タスク', 3); // 最も高い優先度
18    $queue->insert('通常タスク A', 1); // 低い優先度
19    $queue->insert('重要タスク', 2); // 中程度の優先度
20    $queue->insert('通常タスク B', 1); // 低い優先度 (Task Aと同じ優先度の場合、挿入順に依存)
21
22    // イテレーション時にデータのみを抽出するように設定します。
23    // デフォルトではデータと優先度の両方が抽出されますが、
24    // ここではサンプルをシンプルにするため、データのみとします。
25    $queue->setExtractFlags(SplPriorityQueue::EXTR_DATA);
26
27    echo "--- 最初のイテレーション ---\n";
28    // キューをイテレートし、優先度が高いものから要素を取り出します。
29    // このループでイテレータの内部ポインタは末尾に進みます。
30    foreach ($queue as $item) {
31        echo "処理中: " . $item . "\n";
32    }
33
34    echo "\n--- イテレータを巻き戻します (rewind) ---\n";
35    // rewind メソッドを呼び出すことで、イテレータの内部ポインタを
36    // キューの最初の要素の位置に戻します。
37    $queue->rewind();
38
39    echo "\n--- 2回目のイテレーション (巻き戻し後) ---\n";
40    // 再度キューをイテレートすると、rewind によってポインタが最初に戻っているため、
41    // 最初の要素から処理が再開されます。
42    foreach ($queue as $item) {
43        echo "再処理中: " . $item . "\n";
44    }
45}
46
47// 関数を実行して、SplPriorityQueue::rewind の動作を確認します。
48demonstrateSplPriorityQueueRewind();
49

PHP 8のSplPriorityQueueクラスは、要素を優先度に基づいて管理するキューであり、foreachループなどで反復処理（イテレーション）が可能です。SplPriorityQueue::rewindメソッドは、このキューのイテレータが一度完了した後、その内部ポインタを最初の要素の位置に「巻き戻す」役割を果たします。

このメソッドは引数を受け取らず、特定の値を戻り値として返しませんが、キューの内部状態を変更します。通常のイテレーションでは、一度すべての要素を処理すると内部ポインタは末尾に達し、そのままでは再度最初から要素を取り出すことはできません。rewindを呼び出すことで、イテレータのポインタがキューの先頭に戻り、キューの内容を複数回最初から繰り返し処理することが可能になります。

サンプルコードでは、まずキューにタスクを追加し、最初のforeachループで優先度順に処理します。その後$queue->rewind();を呼び出すことでイテレータのポインタを先頭に戻し、2回目のforeachループで再び最初の要素からタスクが処理されることを示しています。このように、rewindメソッドは、一度処理したキューの内容を再度利用したい場合に非常に役立ちます。

Copy
1<?php
2
3/**
4 * SplPriorityQueue クラスの rewind() メソッドの使用例を示します。
5 *
6 * SplPriorityQueue は、優先度に基づいて要素を管理するキュー（待ち行列）です。
7 * rewind() メソッドは、キューをイテレートする際に使用する内部ポインタを先頭に巻き戻すために使われます。
8 * これにより、一度キューの要素を走査し終えた後でも、再び最初から走査を開始できるようになります。
9 */
10function demonstrateSplPriorityQueueRewind(): void
11{
12    // SplPriorityQueue の新しいインスタンスを作成します。
13    $priorityQueue = new SplPriorityQueue();
14
15    // キューにいくつかの要素とその優先度を挿入します。
16    // insert(要素, 優先度) の形式で追加します。
17    // 優先度が高い（数値が大きい）要素から順に取り出されます。
18    $priorityQueue->insert('タスク A', 3);
19    $priorityQueue->insert('タスク B', 1);
20    $priorityQueue->insert('タスク C', 2);
21    $priorityQueue->insert('タスク D', 4); // 最も優先度が高い
22
23    echo "--- 1回目のキューの走査（イテレーション） ---" . PHP_EOL;
24    // foreach ループを使ってキューの要素を走査します。
25    // デフォルトでは、最も優先度の高い要素から取り出されます。
26    // このループが終わると、キューの内部ポインタは終端にあります。
27    foreach ($priorityQueue as $item) {
28        echo "取り出した要素: " . $item . PHP_EOL;
29    }
30    echo "1回目の走査が完了しました。内部ポインタは現在、キューの終端にあります。" . PHP_EOL;
31
32    echo PHP_EOL; // 空行を挿入して見やすくします
33
34    // rewind() メソッドを呼び出します。
35    // これにより、キューの内部ポインタが再び先頭に巻き戻され、
36    // もう一度最初から要素を走査できるようになります。
37    echo "rewind() メソッドを呼び出し、キューの内部ポインタを先頭に巻き戻します。" . PHP_EOL;
38    $priorityQueue->rewind();
39
40    echo PHP_EOL; // 空行を挿入して見やすくします
41
42    echo "--- 2回目のキューの走査（rewind() 呼び出し後） ---" . PHP_EOL;
43    // 再度 foreach ループを使ってキューの要素を走査します。
44    // rewind() のおかげで、1回目と同じ順序で要素が取り出されます。
45    foreach ($priorityQueue as $item) {
46        echo "再び取り出した要素: " . $item . PHP_EOL;
47    }
48    echo "2回目の走査が完了しました。rewind() が正しく機能しました。" . PHP_EOL;
49}
50
51// 上記で定義した関数を実行し、SplPriorityQueue::rewind() の動作を確認します。
52demonstrateSplPriorityQueueRewind();

PHP 8で利用できるSplPriorityQueueクラスは、挿入された要素をその優先度（数値で指定）に基づいて管理する特殊なキュー（待ち行列）です。このキューは、優先度が高い要素から順番に取り出される特性を持っています。

SplPriorityQueue::rewind()メソッドは、このSplPriorityQueueが内部で持っている要素を指し示す「ポインタ」を、キューの「先頭」に巻き戻すための機能を提供します。通常、foreachループなどを用いてキューの要素を順に処理していくと、ポインタはデータの終端へと移動し、一度キューの中身をすべて取り出すと、そのままでは再度最初から要素を読み直すことができません。

このrewind()メソッドを呼び出すことで、内部ポインタは再びキューの最初の要素を指す位置に戻ります。これにより、一度すべての要素を走査し終えた後でも、サンプルコードのように、もう一度最初からキューの中身を順番に処理し直すことが可能になります。このメソッドは引数を一切必要とせず、また戻り値もありません。キューの要素を複数回にわたって繰り返し走査したい場合に活用されます。