【PHP8.x】SplPriorityQueue::EXTR_PRIORITY定数の使い方

Copy
1<?php
2
3/**
4 * SplPriorityQueue::EXTR_PRIORITY 定数を使った優先度付きキューからの要素抽出のサンプルコード。
5 *
6 * この定数を使用すると、SplPriorityQueue から要素を取り出す際に、
7 * 要素そのものだけでなく、割り当てられた優先度も一緒に取得できます。
8 */
9function demonstrateSplPriorityQueueExtraction(): void
10{
11    // 新しい優先度付きキューのインスタンスを作成します。
12    // 優先度が高い（数値が大きい）ものほど先に取り出されます。
13    $queue = new SplPriorityQueue();
14
15    // キューにタスク（要素）とそれに対応する優先度を追加します。
16    // 例: ('タスク名', 優先度)
17    $queue->insert('重要なレポート作成', 100);
18    $queue->insert('メールの返信', 50);
19    $queue->insert('休憩', 10);
20    $queue->insert('ミーティング参加', 120); // 最も優先度が高い
21
22    echo "--- デフォルトの抽出（要素のみ）---\n";
23    // キューの現在の状態をコピーして、デフォルトの抽出動作を示します。
24    // extract() メソッドはデフォルトで要素のみを返します。
25    $defaultQueue = clone $queue;
26    while (!$defaultQueue->isEmpty()) {
27        $item = $defaultQueue->extract();
28        echo "抽出されたタスク: " . $item . "\n";
29    }
30
31    echo "\n--- EXTR_PRIORITY を使った抽出（要素と優先度）---\n";
32    // キューの現在の状態を再度コピーして、EXTR_PRIORITY フラグを使った抽出動作を示します。
33    // SplPriorityQueue::EXTR_PRIORITY を指定すると、extract() メソッドは
34    // 要素と優先度をペアにした連想配列（'data' => 要素, 'priority' => 優先度）で返します。
35    $priorityQueue = clone $queue;
36    while (!$priorityQueue->isEmpty()) {
37        // EXTR_PRIORITY フラグを指定して、要素と優先度の両方を取得します。
38        $itemWithPriority = $priorityQueue->extract(SplPriorityQueue::EXTR_PRIORITY);
39        echo "抽出されたタスク: " . $itemWithPriority['data'] . " (優先度: " . $itemWithPriority['priority'] . ")\n";
40    }
41}
42
43// 関数を実行して動作を確認します。
44demonstrateSplPriorityQueueExtraction();
45
46?>

PHPのSplPriorityQueue::EXTR_PRIORITYは、PHPの標準拡張機能の一つであるSplPriorityQueueクラスに属する定数です。この定数自体に引数や戻り値はありませんが、SplPriorityQueueが提供するextract()メソッドの動作を制御するための「フラグ」として使用されます。

通常、SplPriorityQueueからextract()メソッドを使って要素を取り出すと、キューに格納されていた要素そのものが返されます。しかし、extract()メソッドの引数にSplPriorityQueue::EXTR_PRIORITY定数を指定すると、要素だけでなく、その要素に設定されていた優先度も一緒に取得することが可能になります。

具体的には、この定数を指定した場合、extract()メソッドは抽出された要素と優先度をペアにした連想配列を返します。この連想配列は['data' => 抽出された要素, 'priority' => 要素の優先度]という形式です。これにより、キューから要素を取り出す際に、その要素がどの優先度でキューに入っていたのかを詳細に把握できるようになり、プログラムの柔軟性が向上します。

この機能は、優先度付きキューから単にデータを取り出すだけでなく、そのデータの優先度情報も利用したい場合に役立つため、システムエンジニアを目指す方にとって有用な知識となります。

Copy
1<?php
2
3/**
4 * SplPriorityQueue::EXTR_PRIORITY を使用して、優先度キューから優先度のみを抽出するサンプルコード。
5 *
6 * この関数は SplPriorityQueue に要素を追加し、setExtractFlags() メソッドで抽出モードを
7 * SplPriorityQueue::EXTR_PRIORITY に設定します。
8 * このモードでは、extract() メソッドが要素の「データ」ではなく「優先度」のみを返します。
9 * システムエンジニアを目指す初心者の方にも、データ構造の一つである優先度キューの
10 * 特定の定数（抽出フラグ）の使い方を理解してもらうことを目的としています。
11 */
12function demonstrateSplPriorityQueueExtraction(): void
13{
14    // SplPriorityQueue クラスのインスタンスを作成します。
15    // SplPriorityQueue は、優先度に基づいて要素を管理するデータ構造です。
16    $priorityQueue = new SplPriorityQueue();
17
18    // キューに要素を追加します。各要素は「データ」と「優先度」を持ちます。
19    // 優先度が高い（数値が大きい）ものほど、キューから先に取り出されるようになります。
20    $priorityQueue->insert('Task C', 5); // 最も優先度が高い
21    $priorityQueue->insert('Task A', 3);
22    $priorityQueue->insert('Task B', 1); // 最も優先度が低い
23
24    echo "--- キューに要素を追加しました ---" . PHP_EOL;
25    echo "現在のキューの要素数: " . $priorityQueue->count() . PHP_EOL . PHP_EOL;
26
27    // 抽出フラグを設定します。
28    // SplPriorityQueue::EXTR_PRIORITY を指定することで、
29    // 以降の extract() メソッドは要素の「データ」ではなく「優先度」のみを返すようになります。
30    $priorityQueue->setExtractFlags(SplPriorityQueue::EXTR_PRIORITY);
31
32    echo "--- SplPriorityQueue::EXTR_PRIORITY モードで要素を抽出 ---" . PHP_EOL;
33
34    // キューが空になるまで要素を抽出（取り出し）ます。
35    while (!$priorityQueue->isEmpty()) {
36        // extract() メソッドは、現在の抽出フラグ設定に基づいて要素を取り出します。
37        // ここでは SplPriorityQueue::EXTR_PRIORITY が設定されているため、
38        // 取り出されるのは要素の「優先度」の値のみです。
39        $extractedValue = $priorityQueue->extract();
40        echo "抽出された値 (優先度): " . $extractedValue . PHP_EOL;
41    }
42
43    echo PHP_EOL . "--- すべての要素を抽出しました ---" . PHP_EOL;
44    echo "現在のキューの要素数: " . $priorityQueue->count() . PHP_EOL;
45}
46
47// 関数を実行して、SplPriorityQueue の動作を確認します。
48demonstrateSplPriorityQueueExtraction();
49

PHPのSplPriorityQueueクラスは、要素をその優先度に基づいて管理する特別なデータ構造です。このクラスには、キューから要素を取り出す際の挙動を制御するための「抽出フラグ」と呼ばれる定数が定義されており、SplPriorityQueue::EXTR_PRIORITYはその一つです。

この定数をSplPriorityQueueオブジェクトのsetExtractFlags()メソッドの引数として設定すると、以降、そのオブジェクトのextract()メソッドを呼び出した際に、要素の「データ本体」ではなく、その要素に割り当てられた「優先度」の値のみが戻り値として返されるようになります。定数自体に引数や戻り値はありませんが、setExtractFlags()メソッドがこの定数を引数として受け取り、extract()メソッドがその設定に基づいた戻り値を返します。

サンプルコードでは、まず「Task C」（優先度5）、「Task A」（優先度3）、「Task B」（優先度1）というデータをキューに追加しています。その後、setExtractFlags()メソッドにSplPriorityQueue::EXTR_PRIORITYを指定することで、抽出モードを優先度のみを返すように変更しています。この設定により、whileループ内でextract()メソッドを実行するたびに、取り出されるのはデータそのものではなく、優先度の高い順に「5」「3」「1」という優先度の数値が順に表示されます。

SplPriorityQueue::EXTR_PRIORITYを使うことで、優先度キューから特定の情報（この場合は優先度）のみを効率的に取得できるため、優先度に着目した処理を実装する際に大変役立ちます。