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

Copy
1<?php
2
3// SplMinHeap クラスは、最小ヒープのデータ構造を実装します。
4// このサンプルコードでは、ヒープに要素を追加し、その現在の要素数を取得する方法を示します。
5
6// SplMinHeap の新しいインスタンスを作成します。
7$minHeap = new SplMinHeap();
8
9// ヒープに複数の要素を追加します。
10// SplMinHeap は内部的に要素を整理し、最小値が常に先頭に来るようにします。
11$minHeap->insert(10);
12$minHeap->insert(5);
13$minHeap->insert(20);
14$minHeap->insert(1);
15$minHeap->insert(15);
16
17// SplMinHeap::count() メソッドを使用して、ヒープ内の要素の数を取得します。
18// このメソッドは引数を取らず、ヒープ内の要素数を整数で返します。
19// SplMinHeap は PHP の Countable インターフェースを実装しているため、このメソッドを提供します。
20$elementCount = $minHeap->count();
21
22echo "現在のヒープ内の要素数: " . $elementCount . PHP_EOL; // 例: 現在のヒープ内の要素数: 5
23
24// さらに要素を追加してみましょう。
25$minHeap->insert(3);
26$minHeap->insert(7);
27
28// 再度 count() メソッドを呼び出し、要素数が正しく更新されたことを確認します。
29$newElementCount = $minHeap->count();
30
31echo "追加後のヒープ内の要素数: " . $newElementCount . PHP_EOL; // 例: 追加後のヒープ内の要素数: 7
32
33?>

PHP 8 の SplMinHeap::count() メソッドは、最小ヒープのデータ構造を実装する SplMinHeap クラスのインスタンスが現在保持している要素の数を取得するために使用されます。SplMinHeap は、内部で要素を整理し、常に最小値が先頭に位置するように管理する特殊なコレクションです。

この count() メソッドは、引数を一切必要としません。呼び出されると、ヒープ内に格納されている要素の総数を整数（int型）として返します。SplMinHeap クラスは PHP の Countable インターフェースを実装しているため、この count() メソッドを提供しており、直感的にオブジェクトの要素数を調べることが可能です。

サンプルコードでは、まず SplMinHeap の新しいインスタンスを作成し、複数の数値を insert() メソッドで追加しています。その後、$minHeap->count() を呼び出すことで、追加された要素の合計数を取得し、その結果を表示しています。さらに要素を追加した後、再度 count() メソッドを実行して、ヒープの要素数が正しく更新されることを確認しています。このメソッドは、ヒープの現在のサイズを把握し、処理の制御を行う際に非常に役立ちます。

Copy
1<?php
2
3/**
4 * SplMinHeap の count() メソッドの動作をデモンストレーションします。
5 * SplMinHeap は、最小値が常に「トップ」にある優先度キューです。
6 * ここでは、null 値を要素として追加した場合に count() がどのように振る舞うかを示します。
7 */
8function demonstrateSplMinHeapCountWithNull(): void
9{
10    echo "--- SplMinHeap の count() メソッドのデモンストレーション ---\n";
11
12    // 1. SplMinHeap オブジェクトを初期化します。
13    // 最初は要素が0個です。
14    $heap = new SplMinHeap();
15    echo "初期ヒープの要素数: " . $heap->count() . " (期待値: 0)\n";
16
17    // 2. いくつかの要素を追加します。
18    $heap->insert(10);
19    $heap->insert(5);
20    $heap->insert(20);
21    echo "要素 (10, 5, 20) を追加後のヒープの要素数: " . $heap->count() . " (期待値: 3)\n";
22
23    // 3. null 値をヒープに追加します。
24    // SplMinHeap は null も有効な要素として扱います。
25    $heap->insert(null);
26    echo "null を追加後のヒープの要素数: " . $heap->count() . " (期待値: 4)\n";
27
28    // 4. さらに他の要素を追加します。
29    $heap->insert(7);
30    echo "要素 (7) を追加後のヒープの要素数: " . $heap->count() . " (期待値: 5)\n";
31
32    // 5. count() メソッドは、ヒープに含まれるすべての要素（null を含む）の数を正確に返します。
33    echo "最終的なヒープの要素数: " . $heap->count() . " (期待値: 5)\n";
34
35    echo "--- デモンストレーション終了 ---\n";
36}
37
38// デモンストレーション関数を実行します。
39demonstrateSplMinHeapCountWithNull();
40
41?>

PHP 8のSplMinHeap::count()メソッドは、SplMinHeapオブジェクト内に現在格納されている要素の総数を整数値で返すものです。このメソッドは引数を取りません。

サンプルコードでは、まず空のSplMinHeapを初期化し、その時点での要素数が0であることをcount()で確認しています。その後、数値データ（10, 5, 20）をいくつか追加すると、count()は正しく3を返します。

特に重要な点は、null値をヒープに追加する際の挙動です。SplMinHeapはnullも他の数値と同様に有効な要素として扱います。そのため、nullを追加するとcount()は4を返し、null値が他の要素と同様に数え上げられていることを示します。さらに別の数値（7）を追加すると、最終的にcount()は5となり、ヒープ内の数値とnullを含むすべての要素数が正確に取得できることがわかります。このメソッドにより、SplMinHeapに格納されている要素の量をいつでも簡単に把握できます。