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

Copy
1<?php
2
3/**
4 * SplMaxHeap の count() メソッドと PHP のグローバルな count() 関数 demonstrating.
5 * SplMaxHeap は Countable インターフェースを実装しているため、どちらの count() 関数でも要素数を取得できます。
6 */
7function demonstrateSplMaxHeapCount(): void
8{
9    echo "SplMaxHeap の count() メソッドとグローバルな count() 関数のデモンストレーション:\n";
10
11    // SplMaxHeap の新しいインスタンスを作成します。
12    $heap = new SplMaxHeap();
13
14    echo "ヒープに要素を追加する前:\n";
15    echo "  SplMaxHeap::count(): " . $heap->count() . "\n"; // SplMaxHeap の count() メソッド
16    echo "  グローバル count(): " . count($heap) . "\n\n";   // グローバルな count() 関数
17
18    // ヒープに要素を追加します。
19    // SplMaxHeap は最大の要素が常にルートにくるように要素を整理します。
20    $heap->insert(10);
21    $heap->insert(5);
22    $heap->insert(20);
23    $heap->insert(15);
24
25    echo "ヒープに要素を追加した後:\n";
26    echo "  SplMaxHeap::count(): " . $heap->count() . "\n"; // SplMaxHeap の count() メソッド
27    echo "  グローバル count(): " . count($heap) . "\n\n";   // グローバルな count() 関数
28
29    echo "要素をいくつか取り出した後:\n";
30    // 最大要素を取り出します (20)
31    $removedElement1 = $heap->extract();
32    echo "  取り出した要素: " . $removedElement1 . "\n";
33    echo "  SplMaxHeap::count(): " . $heap->count() . "\n";
34    echo "  グローバル count(): " . count($heap) . "\n\n";
35
36    // 次の最大要素を取り出します (15)
37    $removedElement2 = $heap->extract();
38    echo "  取り出した要素: " . $removedElement2 . "\n";
39    echo "  SplMaxHeap::count(): " . $heap->count() . "\n";
40    echo "  グローバル count(): " . count($heap) . "\n";
41}
42
43// 関数を実行してデモンストレーションを開始します。
44demonstrateSplMaxHeapCount();

PHPのSplMaxHeapクラスのcount()メソッドは、ヒープ（データを特定の順序で保持する特殊なツリー構造）に現在格納されている要素の数を返すために使用されます。このメソッドは引数を必要とせず、現在の要素数を整数（int）として返します。

SplMaxHeapは、PHPが提供するCountableインターフェースを実装しています。そのため、このクラスのインスタンスに対しては、$heap->count()というメソッド呼び出しの形式だけでなく、PHPのグローバルなcount($heap)関数を使用しても、同じく格納されている要素の数を正確に取得できます。

サンプルコードでは、まず空のSplMaxHeapを作成し、count()が0を返すことを確認しています。次に、いくつかの要素（10, 5, 20, 15）を追加すると、count()は追加した要素の総数である4を返します。その後、extract()メソッドで最大の要素（20と15）を一つずつ取り出すたびに、count()の値が適切に減少していく様子が示されており、要素数の管理が正確に行われていることがわかります。

Copy
1<?php
2
3/**
4 * SplMaxHeap を使用して要素を管理し、その数をカウントするサンプルコードです。
5 * キーワード「php count null」に関連して、null 値もヒープの有効な要素として
6 * count メソッドでカウントされることを示します。
7 */
8function demonstrateSplMaxHeapCountWithNull(): void
9{
10    // SplMaxHeap のインスタンスを作成します。
11    // SplMaxHeap は、要素を格納し、最も大きい要素を常に取得できるように設計されたヒープです。
12    $heap = new SplMaxHeap();
13
14    echo "=== SplMaxHeap::count のデモンストレーション ===\n";
15    echo "初期状態のヒープの要素数: " . $heap->count() . "\n\n"; // 最初は要素がないため 0 を出力
16
17    // ヒープに要素を追加します。
18    // PHP 8 の SplMaxHeap は、異なる型の要素（数値、文字列、null など）を
19    // 比較ルールに基づいて格納しようとします。
20    // null は有効な値として扱われ、ヒープに挿入されます。
21    $heap->insert(10);
22    $heap->insert(5);
23    $heap->insert(20);
24    $heap->insert(null); // null 値を要素としてヒープに追加します
25    $heap->insert(15);
26    $heap->insert('apple'); // 文字列も追加してみます
27
28    echo "複数の要素（null を含む）を追加後のヒープの要素数: " . $heap->count() . "\n"; // null も含め、追加した要素の総数を表示します
29
30    echo "\n--- ヒープから要素を抽出 --- \n";
31    // ヒープが空になるまで要素を抽出し、最大値から順に取り出されることを示します。
32    // null や 'apple' のような非数値は、デフォルトの比較ルールに基づいて順序付けされます。
33    // (PHP 8 では、null は数値より小さい、文字列は数値より大きいとみなされることがあります)
34    while (!$heap->isEmpty()) {
35        $element = $heap->extract(); // ヒープから最大の要素を取り出します
36        echo "抽出した要素: " . (is_null($element) ? 'null' : (is_string($element) ? "'{$element}'" : $element)) . "\n";
37    }
38
39    echo "\nすべての要素を抽出後のヒープの要素数: " . $heap->count() . "\n"; // すべて抽出されたので 0 を出力
40}
41
42// 関数を実行します
43demonstrateSplMaxHeapCountWithNull();

PHPのSplMaxHeap::countメソッドは、SplMaxHeapクラスに現在格納されている要素の数を整数で返すメソッドです。このメソッドは引数を必要とせず、ヒープの状態を簡単に把握できます。

SplMaxHeapは、追加された要素の中から常に最も大きな値を持つ要素を効率的に取り出せるように設計された「最大ヒープ」というデータ構造をPHPで利用するためのクラスです。このサンプルコードでは、SplMaxHeapに様々な型の要素を追加し、countメソッドの動作を確認しています。

特に重要な点として、PHP 8のSplMaxHeapでは、数値や文字列だけでなくnull値も有効な要素としてヒープに格納できます。そして、SplMaxHeap::countメソッドは、これらのnull値を含む全ての要素を正確に数え、その合計数を返します。

具体的には、初期状態では要素がないためcount()は0を返します。その後、数値、文字列、そしてnull値といった複数の要素をinsertメソッドで追加すると、count()はこれらの要素すべてを合計した数（サンプルコードでは6）を返します。ヒープから要素をextractしてすべて取り除いた後には、再び0を返します。このように、countメソッドを使用することで、ヒープの現在の要素数を常に正確に把握できます。