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

Copy
1<?php
2
3// SplHeap は抽象クラスであるため、その具象実装の一つである SplMinHeap を使用します。
4// SplMinHeap は、常に最小値の要素が取得できるヒープ（優先度キュー）を実装しています。
5$heap = new SplMinHeap();
6
7// 1. 初期状態のヒープの要素数を取得します。
8// SplHeap::count() メソッドは、ヒープ内に現在格納されている要素の総数を整数で返します。
9echo "初期ヒープの要素数: " . $heap->count() . "\n"; // 出力: 0
10
11// 2. ヒープにいくつかの要素を挿入します。
12// 数値だけでなく、null も有効な要素としてヒープに挿入・格納できます。
13$heap->insert(10);
14$heap->insert(20);
15$heap->insert(5);
16$heap->insert(null); // ここで null 値を要素としてヒープに挿入します。
17
18// 3. 要素挿入後のヒープの要素数を取得します。
19// null 値も他の数値と同様に、1つの有効な要素として正確にカウントされていることを確認できます。
20echo "要素挿入後のヒープの要素数 (nullを含む): " . $heap->count() . "\n"; // 出力: 4 (10, 20, 5, null)
21
22// 4. ヒープから最小値の要素を抽出します。
23// SplMinHeap のため、最も小さい値 (この場合は 5) が抽出されます。
24$extractedValue = $heap->extract();
25echo "抽出された値: " . var_export($extractedValue, true) . "\n";
26
27// 5. 要素抽出後のヒープの要素数を取得します。
28// 要素が1つ減ったことを確認できます。
29echo "要素抽出後のヒープの要素数: " . $heap->count() . "\n"; // 出力: 3
30
31?>

SplHeap::count()メソッドは、PHPのSplHeapクラス、またはその具体的な実装であるSplMinHeapなどのクラスが現在保持している要素の総数を取得するために使用されます。SplHeapは抽象クラスであるため、このサンプルコードでは、常に最小値の要素が取得できるヒープを実装したSplMinHeapクラスを利用しています。

まず、初期状態のヒープには要素がないため、count()メソッドは「0」を返します。次に、数値だけでなくnull値を含む複数の要素をヒープに挿入すると、count()メソッドはこれらの要素を一つ一つ正確に数え上げ、「4」という整数を返します。ここで重要なのは、null値も他の数値と同様に、ヒープ内の有効な要素として正しくカウントされる点です。

さらに、ヒープから最小値の要素を一つ抽出した後も、count()メソッドは残りの要素数を正確に「3」と返します。このメソッドは引数を一切取らず、ヒープに格納されている要素の合計数を整数型（int）で戻り値として返します。これにより、ヒープの状態を簡単に把握できます。

Copy
1<?php
2
3/**
4 * SplHeap::count() メソッドのサンプルコード。
5 *
6 * SplHeap は抽象クラスなので、直接インスタンス化できません。
7 * ここでは SplHeap を継承した具象クラスの一つである SplMinHeap を使用して、
8 * ヒープ内の要素数を取得する方法を示します。
9 */
10
11// SplMinHeap の新しいインスタンスを作成します。
12// これは最小ヒープ（常に最小の要素を先頭に持つヒープ）です。
13$heap = new SplMinHeap();
14
15// ヒープに要素を追加します。
16// SplHeap::insert() メソッドを使用します。
17$heap->insert(10);
18$heap->insert(5);
19$heap->insert(20);
20
21// ヒープ内の要素数を取得します。
22// SplHeap::count() メソッドは、ヒープに含まれる要素の総数を整数で返します。
23echo "ヒープに3つの要素を追加しました。" . PHP_EOL;
24echo "現在のヒープ内の要素数: " . $heap->count() . PHP_EOL; // 出力: 3
25
26// さらに要素を追加します。
27$heap->insert(1);
28$heap->insert(15);
29
30// 要素追加後のヒープ内の要素数を確認します。
31echo PHP_EOL; // 改行
32echo "さらに2つの要素を追加しました。" . PHP_EOL;
33echo "要素追加後のヒープ内の要素数: " . $heap->count() . PHP_EOL; // 出力: 5
34
35// ヒープから要素を取り出します。
36// SplMinHeap::extract() メソッドは、最小の要素を取り除き、その値を返します。
37$extractedValue = $heap->extract();
38echo PHP_EOL; // 改行
39echo "ヒープから要素 (最小値: " . $extractedValue . ") を取り除きました。" . PHP_EOL;
40
41// 要素取り出し後のヒープ内の要素数を確認します。
42echo "要素取り除き後のヒープ内の要素数: " . $heap->count() . PHP_EOL; // 出力: 4
43
44?>

PHPのSplHeap::count()メソッドは、ヒープに格納されている要素の総数を取得する際に利用するメソッドです。SplHeapは抽象クラスであるため直接インスタンス化はできませんが、このサンプルコードではSplHeapを継承したSplMinHeapクラスを使用して動作を示しています。

このcount()メソッドは引数を一切取らず、現在のヒープ内の要素数を整数（int）で返します。サンプルコードでは、まずSplMinHeapにいくつかの要素をinsert()メソッドで追加しています。要素を追加するたびにcount()メソッドを呼び出すことで、ヒープ内の要素数が正しく増加していく様子を確認できます。例えば、最初に3つの要素を追加した後にはcount()は「3」を返します。

さらに要素を追加すると、count()は新しい要素数に更新された値を返します。また、extract()メソッドでヒープから要素を取り除いた後にもcount()を使用すると、取り除かれた要素の分だけ要素数が減少していることが確認できます。このように、SplHeap::count()は、ヒープの現在の要素数を正確に取得できる便利な機能です。