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

Copy
1<?php
2
3/**
4 * SplPriorityQueue クラスの isEmpty() メソッドの使用例。
5 * キューが空であるかどうかをチェックする方法を示します。
6 */
7
8// 優先度キューの新しいインスタンスを作成します。
9$priorityQueue = new SplPriorityQueue();
10
11echo "--- キューが空の状態 ---" . PHP_EOL;
12// キューが空の状態で isEmpty() を呼び出します。
13// 戻り値は bool (true) となります。
14echo "isEmpty(): ";
15var_dump($priorityQueue->isEmpty());
16
17// キューに要素を追加します。
18// insert(データ, 優先度) の形式で追加します。
19// 優先度が高い（数値が大きい）ものから先に取り出されます。
20$priorityQueue->insert('タスクA', 3); // 優先度 高
21$priorityQueue->insert('タスクB', 1); // 優先度 低
22$priorityQueue->insert('タスクC', 2); // 優先度 中
23
24echo PHP_EOL . "--- 要素を追加した状態 ---" . PHP_EOL;
25// 要素を追加した後で isEmpty() を呼び出します。
26// 戻り値は bool (false) となります。
27echo "isEmpty(): ";
28var_dump($priorityQueue->isEmpty());
29
30echo PHP_EOL . "--- キューから要素を取り出す ---" . PHP_EOL;
31// キューが空になるまで要素を取り出します。
32// SplPriorityQueue の extract() メソッドは、最も優先度の高い要素を返します。
33while (!$priorityQueue->isEmpty()) {
34    $item = $priorityQueue->extract();
35    echo "取り出した要素: " . $item . PHP_EOL;
36}
37
38echo PHP_EOL . "--- 要素をすべて取り出した状態 ---" . PHP_EOL;
39// すべての要素を取り出した後で isEmpty() を呼び出します。
40// 戻り値は bool (true) となります。
41echo "isEmpty(): ";
42var_dump($priorityQueue->isEmpty());
43
44?>

PHP 8で提供されるSplPriorityQueueクラスのisEmpty()メソッドは、優先度キューが現在空であるかどうかを効率的に判定するために使用されます。このメソッドは引数を一切取らず、実行結果として真偽値（bool）を返します。具体的には、キュー内に一つも要素が含まれていない場合はtrueを、一つでも要素が存在する場合はfalseを返します。

サンプルコードでは、まず新しいSplPriorityQueueインスタンスを作成し、その直後にisEmpty()を呼び出すと、まだ要素がないためtrueが返されることを示しています。次に、いくつかの要素をキューに追加すると、isEmpty()の戻り値はfalseに変化し、キューに要素があることを示します。その後、whileループとextract()メソッドを使ってキューからすべての要素を取り出すと、再びキューが空の状態になるため、isEmpty()は最終的にtrueを返すようになります。このように、isEmpty()メソッドは、キューの現在の状態を判断し、プログラムの適切な制御フローを構築する際に非常に役立ちます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * SplPriorityQueue::isEmpty() メソッドの使用例を示します。
7 *
8 * この関数は、PHPのSplPriorityQueueが空であるかどうかを判定する方法を、
9 * 初心者にも分かりやすく簡潔に示します。
10 * キーワードの「string」を考慮し、キューには文字列データを扱います。
11 */
12function demonstrateSplPriorityQueueIsEmpty(): void
13{
14    // SplPriorityQueue のインスタンスを作成
15    // このキューは、追加された要素を優先度に基づいて管理します。
16    $priorityQueue = new SplPriorityQueue();
17
18    echo "--- キューの初期状態 --- \n";
19    // キューが空であるかを確認します。
20    // SplPriorityQueue::isEmpty() は、キューに要素が1つも含まれていない場合に true を返します。
21    if ($priorityQueue->isEmpty()) {
22        echo "キューは現在空です。 (SplPriorityQueue::isEmpty() は true を返しました)\n";
23    } else {
24        echo "キューは現在空ではありません。 (SplPriorityQueue::isEmpty() は false を返しました)\n";
25    }
26
27    echo "\n--- キューに文字列データを追加 --- \n";
28    // キューにいくつかの文字列データを優先度付きで追加します。
29    // 第一引数が要素、第二引数が優先度です（数値が大きいほど優先度が高い）。
30    $priorityQueue->insert('レポート作成', 100); // 高い優先度
31    $priorityQueue->insert('メール返信', 50);    // 中程度の優先度
32    $priorityQueue->insert('資料整理', 10);      // 低い優先度
33
34    // 要素を追加した後、キューが空でないことを確認します。
35    if ($priorityQueue->isEmpty()) {
36        echo "キューは現在空です。 (SplPriorityQueue::isEmpty() は true を返しました)\n";
37    } else {
38        echo "キューは現在空ではありません。 (SplPriorityQueue::isEmpty() は false を返しました。要素数: " . $priorityQueue->count() . ")\n";
39    }
40
41    echo "\n--- キューからすべての要素を取り出し --- \n";
42    // キューからすべての要素を取り出します。
43    // SplPriorityQueue はデフォルトで優先度の高い順に要素を取り出します。
44    // setExtractFlags() で取り出す値の形式を設定できます（ここではデータのみ）。
45    $priorityQueue->setExtractFlags(SplPriorityQueue::EXTR_DATA);
46
47    while (!$priorityQueue->isEmpty()) {
48        // extract() メソッドで最も優先度の高い要素を取り出します。
49        $task = $priorityQueue->extract();
50        echo "取り出したタスク: " . $task . "\n";
51    }
52
53    // すべての要素を取り出した後、キューが空であることを確認します。
54    if ($priorityQueue->isEmpty()) {
55        echo "キューは現在空です。 (SplPriorityQueue::isEmpty() は true を返しました)\n";
56    } else {
57        echo "キューは現在空ではありません。 (SplPriorityQueue::isEmpty() は false を返しました)\n";
58    }
59}
60
61// 定義した関数を実行し、SplPriorityQueue::isEmpty() の動作を確認します。
62demonstrateSplPriorityQueueIsEmpty();

SplPriorityQueue::isEmpty()は、PHPの標準ライブラリであるSPLが提供する優先度付きキュー（SplPriorityQueue）が現在空であるかどうかを判定するためのメソッドです。このメソッドは引数を必要とせず、キューに要素が一つも含まれていない場合はtrueを、一つ以上の要素が含まれている場合はfalseをブール値として返します。

サンプルコードでは、まずSplPriorityQueueのインスタンスを生成した直後の状態を確認します。この時点ではキューは空であるため、isEmpty()はtrueを返します。次に、insert()メソッドを使って「レポート作成」や「メール返信」といった文字列データを異なる優先度でキューに追加します。要素が追加された後では、isEmpty()はfalseを返し、キューが空ではないことを示します。

その後、whileループとextract()メソッドを使用して、キューに格納されたすべての要素を優先度の高い順に取り出します。このとき、setExtractFlags(SplPriorityQueue::EXTR_DATA)を設定することで、要素データのみを抽出するようにしています。すべての要素がキューから取り出され尽くすと、キューは再び空になります。その結果、isEmpty()は再度trueを返し、キューが空になったことを正確に伝えます。この一連の流れを通じて、SplPriorityQueue::isEmpty()がキューの状態に応じてどのようにtrueまたはfalseを返すかを確認できます。