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

Copy
1<?php
2
3/**
4 * SplPriorityQueue クラスは Countable インターフェースを実装しているため、
5 * count() メソッドとグローバルな count() 関数の両方で要素数を取得できます。
6 * このサンプルは、その機能と SplPriorityQueue::count() メソッドの使用法を示します。
7 */
8
9// 優先度キューの新しいインスタンスを作成します。
10$priorityQueue = new SplPriorityQueue();
11
12// いくつかの要素をキューに追加します。
13// insert(要素, 優先度)
14$priorityQueue->insert('Task A', 3); // 優先度3
15$priorityQueue->insert('Task B', 1); // 優先度1
16$priorityQueue->insert('Task C', 2); // 優先度2
17
18// SplPriorityQueue::count() メソッドを使用して、キュー内の要素数を取得します。
19$elementCountByMethod = $priorityQueue->count();
20echo "SplPriorityQueue::count() メソッドによる要素数: " . $elementCountByMethod . PHP_EOL;
21
22// SplPriorityQueue は Countable インターフェースを実装しているため、
23// グローバルな count() 関数も使用できます。
24$elementCountByFunction = count($priorityQueue);
25echo "count() 関数による要素数: " . $elementCountByFunction . PHP_EOL;
26
27// 要素をさらに追加してみます。
28$priorityQueue->insert('Task D', 4);
29
30// 要素追加後のキューのサイズを再度確認します。
31$elementCountAfterAdd = $priorityQueue->count();
32echo "要素追加後の SplPriorityQueue::count() メソッドによる要素数: " . $elementCountAfterAdd . PHP_EOL;
33
34// SplPriorityQueue が実際に Countable インターフェースを実装していることを確認できます。
35if ($priorityQueue instanceof Countable) {
36    echo "SplPriorityQueue オブジェクトは Countable インターフェースを実装しています。" . PHP_EOL;
37}
38
39?>

SplPriorityQueue::count()は、PHPのSplPriorityQueueクラスに格納されている要素の数を取得するメソッドです。引数はなく、キュー内の要素数を整数（int）として返します。

SplPriorityQueueクラスはCountableインターフェースを実装しているため、このメソッドの他に、グローバルなcount()関数にSplPriorityQueueオブジェクトを渡すことでも要素数を取得できます。

サンプルコードでは、まずSplPriorityQueueに要素を追加し、$priorityQueue->count()メソッドでその数を表示します。次に、グローバルなcount()関数でも同じ結果が得られることを確認します。さらに要素を追加した後、再度count()メソッドを呼び出し、要素数の更新を確認しています。この機能は、キュー内の要素数を簡単に把握するのに役立ちます。

Copy
1<?php
2
3// SplPriorityQueue を使用して優先度付きキューを操作し、要素数を取得する例
4// キーワード "php count null" に関連して、null も有効な要素としてカウントされることを示します。
5
6// SplPriorityQueue オブジェクトを初期化
7$priorityQueue = new SplPriorityQueue();
8
9echo "--- 初期状態 ---\n";
10// キューが空の場合の要素数を取得
11// count() メソッドはキュー内の要素数を整数で返します。
12echo "初期のキュー内の要素数: " . $priorityQueue->count() . "\n\n"; // 出力: 0
13
14echo "--- 要素の追加 ---\n";
15// キューに複数の要素を追加します。
16// insert(mixed $value, mixed $priority) メソッドを使用します。
17// priority が高いほど、優先度が高くなります。
18$priorityQueue->insert('タスクA (優先度高)', 10);
19$priorityQueue->insert('タスクB (優先度中)', 5);
20$priorityQueue->insert(null, 7); // null 値も有効な要素としてキューに追加されます
21$priorityQueue->insert('タスクC (優先度低)', 1);
22$priorityQueue->insert(0, 3); // 0 も null とは異なる有効な要素です
23
24// 要素追加後のキュー内の要素数を取得
25// null や 0 も個別の要素としてカウントされます。
26echo "要素追加後のキュー内の要素数: " . $priorityQueue->count() . "\n\n"; // 出力: 5
27
28echo "--- 要素の取り出しとカウントの変化 ---\n";
29// キューから最も優先度の高い要素を取り出します。
30// extract() メソッドは最も優先度の高い要素を返し、キューから削除します。
31if (!$priorityQueue->isEmpty()) {
32    $firstExtracted = $priorityQueue->extract();
33    echo "取り出した要素 (最も優先度が高い): ";
34    var_dump($firstExtracted); // 出力: string(24) "タスクA (優先度高)"
35}
36
37// 要素取り出し後のキュー内の要素数を取得
38echo "最初の要素取り出し後のキュー内の要素数: " . $priorityQueue->count() . "\n\n"; // 出力: 4
39
40// null 値の要素が取り出されるまでループで取り出し、カウントの変化を確認します
41echo "--- null値の要素が取り出されるまで ---\n";
42while (!$priorityQueue->isEmpty()) {
43    $currentCount = $priorityQueue->count();
44    $extracted = $priorityQueue->extract();
45    echo "現在の要素数: " . $currentCount . ", 取り出した要素: ";
46    var_dump($extracted);
47
48    if ($extracted === null) {
49        echo "--> null 値の要素を取り出しました。\n";
50        break; // null を取り出したらループを終了
51    }
52}
53
54// null 値の要素を取り出した後のキュー内の要素数を取得
55echo "null要素取り出し後のキュー内の要素数: " . $priorityQueue->count() . "\n";
56
57?>

SplPriorityQueue::countメソッドは、PHPのSplPriorityQueueオブジェクトに現在格納されている要素の総数を取得するために使用されます。SplPriorityQueueは、要素に優先度を付けて管理できる特殊なキューであり、count()メソッドは、このキューの現在の要素数を整数値で返します。このメソッドは引数を必要としません。

サンプルコードでは、まずSplPriorityQueueを初期化し、空の状態でのcount()が0を返すことを示しています。次に、insert()メソッドを使用して複数の要素をキューに追加します。ここで注目すべき点は、文字列や数値だけでなく、null値や0といった値も他のデータと同様に、有効な要素としてキューに追加され、count()メソッドによって正確に数えられるという点です。全ての要素を追加した後でcount()を実行すると、追加された要素の合計数である5が返ります。

さらに、extract()メソッドで最も優先度の高い要素をキューから取り出すたびに、count()メソッドがその減少を正確に示します。これにより、キューの現在の要素数をリアルタイムに把握できることがわかります。特に、null値の要素が取り出されるまでのカウントの変化を追うことで、nullが有効な要素としてカウントされ、取り出されると数が減る挙動が明確に理解できます。SplPriorityQueue::countメソッドは、優先度付きキューの要素数を簡単に確認し、その状態を管理する上で非常に役立つ基本的なメソッドです。