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

Copy
1<?php
2
3/**
4 * SplMaxHeapのisEmptyメソッドの動作を示すサンプルコード。
5 *
6 * SplMaxHeapは、常に最大の要素が先頭に来る優先度キューの一種です。
7 * isEmptyメソッドは、ヒープが空かどうかを真偽値で返します。
8 */
9
10// 新しい最大ヒープを作成します。
11$heap = new SplMaxHeap();
12
13echo "初期状態のヒープが空かどうかの確認:\n";
14// ヒープが空か確認し、結果を表示します。
15// まだ何も要素を追加していないため、trueが返されます。
16var_dump($heap->isEmpty()); // true
17
18echo "\n要素を追加:\n";
19// ヒープに要素を追加します。
20$heap->insert(10);
21$heap->insert(5);
22$heap->insert(20); // 最大値
23
24echo "要素追加後のヒープが空かどうかの確認:\n";
25// 要素を追加したので、ヒープは空ではありません。
26// この時点でfalseが返されます。
27var_dump($heap->isEmpty()); // false
28
29echo "\n要素を全て取り出す:\n";
30// ヒープから要素を全て取り出します。
31// SplMaxHeapは常に最大の要素を取り出します。
32echo "取り出した要素1: " . $heap->extract() . "\n"; // 20
33echo "取り出した要素2: " . $heap->extract() . "\n"; // 10
34echo "取り出した要素3: " . $heap->extract() . "\n"; // 5
35
36echo "全ての要素を取り出した後のヒープが空かどうかの確認:\n";
37// 全ての要素を取り出したので、ヒープは再び空になります。
38// 再びtrueが返されます。
39var_dump($heap->isEmpty()); // true
40
41?>

PHPのSplMaxHeapクラスは、常に最大の要素を素早く取り出せるように設計された、優先度キューの一種です。このSplMaxHeapが提供するisEmptyメソッドは、現在のヒープ内に要素が一つも存在しない場合にtrue（真）、一つでも要素が存在する場合にはfalse（偽）を返す機能を持っています。

このメソッドは引数を一切必要としません。戻り値は常にbool型、つまり真偽値で結果を返します。

サンプルコードでは、まず新しいSplMaxHeapを作成した直後にisEmpty()を呼び出しています。この時点ではまだ何も要素を追加していないため、trueが返されます。次に、複数の要素（10, 5, 20）をヒープに追加します。要素が存在する状態になるため、再度isEmpty()を呼び出すとfalseが返されることが確認できます。

その後、extract()メソッドを使ってヒープから全ての要素を一つずつ取り出します。SplMaxHeapは常に最大の要素から取り出すため、20、10、5の順に取り出されます。全ての要素を取り終えるとヒープは再び空の状態になりますので、最後のisEmpty()の呼び出しでは再度trueが返されます。

isEmptyメソッドは、ヒープが処理すべき要素を持っているか、あるいは全ての処理が完了したかなどを判定する際に非常に役立つ基本的なメソッドです。

Copy
1<?php
2
3/**
4 * SplMaxHeap クラスの isEmpty() メソッドの使用例を示します。
5 * このメソッドは、ヒープが要素を含んでいるかどうかをチェックします。
6 */
7function demonstrateSplMaxHeapIsEmpty(): void
8{
9    echo "--- SplMaxHeap::isEmpty() メソッドのデモンストレーション ---" . PHP_EOL;
10
11    // SplMaxHeap の新しいインスタンスを作成します。
12    // SplMaxHeap は、常に最大の要素が最初に抽出されるヒープデータ構造です。
13    $heap = new SplMaxHeap();
14
15    echo "\n現在のヒープの状態:" . PHP_EOL;
16
17    // 初期状態でヒープが空かどうかを確認します。
18    // まだ何も追加していないため、true が返されるはずです。
19    if ($heap->isEmpty()) {
20        echo "ヒープは空です。" . PHP_EOL;
21    } else {
22        echo "ヒープは空ではありません。" . PHP_EOL;
23    }
24
25    // ヒープに要素を追加します。
26    echo "\n--- 要素を追加します ---" . PHP_EOL;
27    $heap->insert(10);
28    echo "数値 10 を追加しました。" . PHP_EOL;
29    $heap->insert(5);
30    echo "数値 5 を追加しました。" . PHP_EOL;
31    $heap->insert(20);
32    echo "数値 20 を追加しました。" . PHP_EOL;
33
34    echo "\n現在のヒープの状態:" . PHP_EOL;
35
36    // 要素を追加した後にヒープが空かどうかを確認します。
37    // 要素が含まれているため、false が返されるはずです。
38    if ($heap->isEmpty()) {
39        echo "ヒープは空です。" . PHP_EOL;
40    } else {
41        echo "ヒープは空ではありません。要素数: " . $heap->count() . PHP_EOL;
42    }
43
44    // ヒープから最大の要素を抽出します。
45    // SplMaxHeap なので、現在の最大の要素である 20 が抽出されます。
46    echo "\n--- 最大の要素を抽出します ---" . PHP_EOL;
47    $maxElement = $heap->extract();
48    echo "抽出された要素: " . $maxElement . PHP_EOL;
49
50    echo "\n現在のヒープの状態:" . PHP_EOL;
51
52    // 1つの要素を抽出した後にヒープが空かどうかを確認します。
53    // まだ他の要素 (10 と 5) が残っているため、false が返されるはずです。
54    if ($heap->isEmpty()) {
55        echo "ヒープは空です。" . PHP_EOL;
56    } else {
57        echo "ヒープは空ではありません。要素数: " . $heap->count() . PHP_EOL;
58    }
59
60    // ヒープに残っているすべての要素を抽出し、ヒープを空にします。
61    echo "\n--- 残りのすべての要素を抽出します ---" . PHP_EOL;
62    while (!$heap->isEmpty()) {
63        $element = $heap->extract();
64        echo "抽出された要素: " . $element . PHP_EOL;
65    }
66
67    echo "\n現在のヒープの状態:" . PHP_EOL;
68
69    // すべての要素を抽出した後にヒープが空かどうかを確認します。
70    // すべての要素が取り出されたため、true が返されるはずです。
71    if ($heap->isEmpty()) {
72        echo "ヒープは空です。" . PHP_EOL;
73    } else {
74        echo "ヒープは空ではありません。" . PHP_EOL;
75    }
76
77    echo "\n--- デモンストレーション終了 ---" . PHP_EOL;
78}
79
80// 関数を実行して、SplMaxHeap::isEmpty() の動作を確認します。
81demonstrateSplMaxHeapIsEmpty();
82

PHP 8のSplMaxHeapクラスに属するisEmpty()メソッドは、ヒープデータ構造が現在要素を含んでいるかどうかを判定するために使用されます。SplMaxHeapは、追加された要素の中から常に最大の要素を効率的に取得できるように整理される特殊なデータ構造です。

このisEmpty()メソッドは引数を取らず、戻り値として真偽値（bool型）を返します。ヒープが完全に空で、何の要素も含まれていない場合はtrueが返され、一つでも要素が存在する場合はfalseが返されます。

サンプルコードでは、まずSplMaxHeapを新しく作成した直後にisEmpty()を呼び出し、trueが返されることを確認しています。これは、初期状態ではヒープが空であることを意味します。次に、いくつかの数値をヒープに追加すると、isEmpty()はfalseを返します。これはヒープに要素が存在することを示します。さらに、ヒープから最大の要素を抽出するなど、要素を一つずつ取り除いていき、最終的にすべての要素がヒープからなくなると、再びisEmpty()がtrueを返し、ヒープが空になったことを確認できます。このように、isEmpty()メソッドはヒープの状態を簡単にチェックできる便利な機能です。