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

Copy
1<?php
2
3/**
4 * SplHeap::isEmpty() メソッドの動作を示すサンプル関数。
5 *
6 * この関数は、SplHeap (具体的な実装として SplMinHeap) が空であるかどうかの状態変化を示します。
7 * SplHeap::isEmpty() は、SplHeap のインスタンスに要素が含まれていない場合に true を返します。
8 * これは、配列や文字列が空であるかを確認する PHP の empty() 関数と概念的には似ていますが、
9 * 対象が特殊なデータ構造である SplHeap である点が異なります。
10 */
11function demonstrateSplHeapIsEmpty(): void
12{
13    echo "--- SplHeap::isEmpty() メソッドのデモンストレーション ---\n";
14
15    // SplHeap は抽象クラスなので、具体的なヒープ実装である SplMinHeap を使用します。
16    // SplMinHeap は、最小値が常に頂点に位置するヒープです。
17    $heap = new SplMinHeap();
18    echo "新しい SplMinHeap を作成しました。\n";
19
20    // 1. 初期状態でヒープが空であることを確認します。
21    // SplHeap::isEmpty() は、ヒープに要素が含まれていない場合に true を返します。
22    echo "ヒープは現在空ですか？ " . ($heap->isEmpty() ? 'はい' : 'いいえ') . "\n"; // 出力例: はい
23
24    echo "\n--- 要素の追加 ---\n";
25    // 2. いくつかの要素をヒープに追加します。
26    $heap->insert(10);
27    $heap->insert(5);
28    $heap->insert(20);
29    echo "要素 (10, 5, 20) を追加しました。\n";
30
31    // 3. 要素を追加した後、ヒープが空ではないことを確認します。
32    echo "ヒープは現在空ですか？ " . ($heap->isEmpty() ? 'はい' : 'いいえ') . "\n"; // 出力例: いいえ
33
34    echo "\n--- 要素の取り出し ---\n";
35    // 4. ヒープからすべての要素を取り出します。
36    // SplMinHeap::extract() は、ヒープから最小の要素を取り除いて返します。
37    // isEmpty() メソッドは、ループの継続条件としてデータ構造が空になるまで処理を続ける際に頻繁に使用されます。
38    while (!$heap->isEmpty()) {
39        $element = $heap->extract();
40        echo "要素 '" . $element . "' を取り出しました。\n";
41    }
42    echo "すべての要素を取り出しました。\n";
43
44    // 5. すべての要素を取り出した後、ヒープが空であることを再度確認します。
45    echo "ヒープは現在空ですか？ " . ($heap->isEmpty() ? 'はい' : 'いいえ') . "\n"; // 出力例: はい
46}
47
48// サンプル関数を実行します。
49demonstrateSplHeapIsEmpty();

SplHeap::isEmpty() メソッドは、PHPのヒープというデータ構造が現在空であるか否かを判定します。引数はなく、ヒープに要素が一つも存在しない場合は true を、要素が一つでもあれば false を bool 型で返します。

サンプルコードでは、まず SplMinHeap (ヒープの一種) を作成し、初期状態では isEmpty() が true を返すことを示します。次に要素を追加すると isEmpty() は false に変わり、ヒープが空でないことを示します。このメソッドは、while (!$heap->isEmpty()) のように、ヒープからすべての要素を取り出すループ処理の継続条件として頻繁に利用されます。すべての要素を取り出し終えると、再度 isEmpty() は true を返します。

この機能は、PHPの empty() 関数が配列や文字列の空判定を行うのと概念的には似ています。SplHeap::isEmpty() はヒープという特定のデータ構造の状態を正確に判断することに特化しており、システムのデータ構造が空かどうかを安全に確認し、処理を制御するために役立ちます。

Copy
1<?php
2
3/**
4 * SplHeap::isEmpty() メソッドの使用例。
5 *
6 * このコードは、SplHeap (具体的には SplMaxHeap) インスタンスが
7 * 要素を保持しているかどうかを判定する isEmpty() メソッドの動作を示します。
8 *
9 * PHPの組み込み関数である empty() は変数の中身が空かどうかをチェックしますが、
10 * SplHeap::isEmpty() は、SplHeap データ構造自体が空かどうかをチェックする
11 * 専用のメソッドです。
12 * キーワードの「string」に関連付けて、ヒープには文字列が格納されています。
13 */
14
15// SplMaxHeap クラスは SplHeap を継承し、最大ヒープの比較ロジックを実装しています。
16// これにより、最も大きい要素が常にルートに位置するヒープが作成されます。
17$heap = new SplMaxHeap();
18
19echo "ヒープが初期状態で空かどうかをチェックします。\n";
20echo "isEmpty() の結果: " . ($heap->isEmpty() ? "true" : "false") . "\n"; // true を期待
21
22// キーワード「string」に関連付けて、ヒープに文字列要素を追加します。
23echo "\nヒープに要素を追加します。\n";
24$heap->insert("apple");
25$heap->insert("banana");
26$heap->insert("cherry");
27
28echo "要素追加後のヒープが空かどうかをチェックします。\n";
29echo "isEmpty() の結果: " . ($heap->isEmpty() ? "true" : "false") . "\n"; // false を期待
30
31// ヒープからすべての要素を取り出します。
32echo "\nヒープからすべての要素を取り出します。\n";
33while (!$heap->isEmpty()) {
34    $element = $heap->extract(); // SplMaxHeap なので、辞書順で最も大きい要素が取り出されます。
35    echo "取り出した要素: " . $element . "\n";
36}
37
38echo "\nすべての要素を取り出した後のヒープが空かどうかをチェックします。\n";
39echo "isEmpty() の結果: " . ($heap->isEmpty() ? "true" : "false") . "\n"; // true を期待
40
41?>

PHP 8のSplHeap::isEmpty()メソッドは、データ構造の一種であるヒープ（SplHeapクラス）が現在、要素を一つも保持していない「空の状態」であるかどうかを判定するために使用されます。このメソッドは引数を必要とせず、ヒープが空であればブール値のtrueを、一つでも要素があればfalseを返します。

提供されたサンプルコードでは、まずSplMaxHeap（SplHeapを継承したクラス）のインスタンスを作成します。この初期状態のヒープは空であるため、isEmpty()を呼び出すとtrueが返されます。次に、キーワード「string」に関連付けて、"apple", "banana", "cherry"といった文字列要素をヒープに追加します。要素が追加された後のヒープは空ではないため、この時点でisEmpty()を呼び出すとfalseが返されます。

その後、whileループ内でextract()メソッドを使い、ヒープからすべての要素を取り出していきます。すべての要素が取り出され、ヒープが再び空になると、最後にisEmpty()を呼び出したときにはtrueが返されることが確認できます。

PHPには変数が空であるかをチェックする組み込み関数empty()がありますが、SplHeap::isEmpty()はSplHeapオブジェクトが管理するデータ構造自体が空かどうかを正確に判定するための専用メソッドです。