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

Copy
1<?php
2
3/**
4 * SplPriorityQueue の extract() メソッドで SplPriorityQueue::EXTR_DATA 定数を使用する例を示します。
5 *
6 * SplPriorityQueue は、優先度に基づいて要素を並べ替えるキュー（待ち行列）を実装するクラスです。
7 * extract() メソッドはキューから最も優先度の高い要素を取り出しますが、
8 * その戻り値の形式は setExtractFlags() メソッドで制御できます。
9 * SplPriorityQueue::EXTR_DATA を設定すると、抽出時にデータ部分のみが返されます。
10 * (デフォルトでは、データと優先度の両方を含む配列が返されます。)
11 */
12function demonstrateSplPriorityQueueExtractData(): void
13{
14    // SplPriorityQueue の新しいインスタンスを作成します。
15    $pq = new SplPriorityQueue();
16
17    // キューに要素を挿入します。
18    // insert(データ, 優先度) の形式で挿入します。
19    // 優先度が高い（数値が大きい）要素ほど、先に抽出されます。
20    $pq->insert('会議の準備', 3); // 最も優先度が高い
21    $pq->insert('メールの確認', 1); // 優先度が低い
22    $pq->insert('資料の作成', 2); // 中間の優先度
23
24    echo "--- SplPriorityQueue::EXTR_DATA を設定して要素を抽出 ---" . PHP_EOL;
25
26    // setExtractFlags() を使用して、extract() メソッドが返す内容を設定します。
27    // SplPriorityQueue::EXTR_DATA は、データ部分のみを返すように指定します。
28    $pq->setExtractFlags(SplPriorityQueue::EXTR_DATA);
29
30    // キューが空になるまで要素を抽出し、その内容を表示します。
31    // キューは自動的に優先度順に要素をソートし、最も優先度の高いものから取り出されます。
32    while (!$pq->isEmpty()) {
33        $extractedItem = $pq->extract();
34        echo "抽出されたデータ: " . $extractedItem . PHP_EOL;
35    }
36
37    echo PHP_EOL;
38    echo "キューは空になりました。" . PHP_EOL;
39}
40
41// 関数を実行して、SplPriorityQueue::EXTR_DATA の動作を確認します。
42demonstrateSplPriorityQueueExtractData();
43

PHP 8で提供されるSplPriorityQueue::EXTR_DATAは、SplPriorityQueueクラスで使用される定数です。SplPriorityQueueは、優先度に基づいて要素を管理する特殊なキュー（待ち行列）であり、最も優先度の高い要素から順に取り出すことができます。

このEXTR_DATA定数は、SplPriorityQueueのsetExtractFlags()メソッドと組み合わせて使用されます。setExtractFlags()メソッドは、キューから要素を取り出すextract()メソッドがどのような形式で値を返すかを設定する役割があります。

通常、extract()メソッドは取り出した要素の「データ」とその「優先度」の両方を含む配列を返します。しかし、setExtractFlags(SplPriorityQueue::EXTR_DATA)と設定することで、extract()メソッドは優先度を考慮せず、取り出した要素の「データ」部分のみを返します。この定数自体に引数や固有の戻り値はありませんが、setExtractFlags()の引数として渡すことで、extract()メソッドの戻り値の挙動を簡潔に制御できるのが特徴です。

サンプルコードでは、SplPriorityQueueに複数のタスクを優先度付きで追加した後、setExtractFlags(SplPriorityQueue::EXTR_DATA)を設定しています。これにより、whileループでextract()メソッドを呼び出すたびに、タスク名（データ）のみが順に抽出され、表示される様子を確認できます。これは、必要な情報だけを効率的に扱いたい場合に非常に便利です。

Copy
1<?php
2
3/**
4 * SplPriorityQueue クラスの SplPriorityQueue::EXTR_DATA 定数の使用例を示します。
5 * この定数は、setExtractFlags メソッドと組み合わせて、
6 * キューから要素を取り出す際に「データのみ」を返すよう設定するために使用します。
7 */
8function demonstrateSplPriorityQueueExtractData(): void
9{
10    // SplPriorityQueue のインスタンスを作成します。
11    // SplPriorityQueue は、要素とその優先度を管理するキューです。
12    $queue = new SplPriorityQueue();
13
14    echo "--- 優先度付きキューに要素を追加します ---\n";
15
16    // insert() メソッドで要素をキューに追加します。
17    // 引数は (データ, 優先度) の順です。優先度が高いほど先に取り出されます。
18    $queue->insert('りんご', 5);    // 優先度5 (最も高い)
19    $queue->insert('バナナ', 2);    // 優先度2
20    $queue->insert('みかん', 3);    // 優先度3
21    $queue->insert('ぶどう', 1);    // 優先度1 (最も低い)
22
23    echo "現在のキューの要素数: " . $queue->count() . "\n\n";
24
25    // setExtractFlags() メソッドを使って、extract() メソッドが何を返すかを設定します。
26    // SplPriorityQueue::EXTR_DATA を指定すると、データのみが返されるようになります。
27    echo "--- 抽出フラグを SplPriorityQueue::EXTR_DATA に設定します ---\n";
28    $queue->setExtractFlags(SplPriorityQueue::EXTR_DATA);
29    echo "設定後、extract() はデータ値のみを返します。\n\n";
30
31    echo "--- キューから要素を優先度順に取り出します (データのみ) ---\n";
32
33    // キューが空になるまで要素を取り出します。
34    // valid() はキューにまだ要素があるかを確認します。
35    while ($queue->valid()) {
36        // extract() メソッドは、現在の最も優先度の高い要素を取り出し、キューから削除します。
37        // setExtractFlags() で設定した通り、ここではデータ値のみが返されます。
38        $item = $queue->extract();
39        echo "取り出されたデータ: " . $item . "\n";
40    }
41
42    echo "\nすべての要素が取り出されました。\n";
43    echo "最終的なキューの要素数: " . $queue->count() . "\n";
44}
45
46// 関数を実行して、動作を確認します。
47demonstrateSplPriorityQueueExtractData();

SplPriorityQueue::EXTR_DATAは、PHPのSplPriorityQueueクラスで使用される定数です。SplPriorityQueueは、登録された要素を、それぞれに設定された優先度に基づいて管理し、最も優先度の高い要素から順に取り出すためのデータ構造を提供します。

この定数は、主にSplPriorityQueue::setExtractFlags()メソッドと組み合わせて使用されます。setExtractFlags()メソッドは、キューから要素を取り出す際に呼び出すextract()メソッドが、どのような形式で値を返すかを制御するために利用されます。

SplPriorityQueue::setExtractFlags(SplPriorityQueue::EXTR_DATA)のように設定することで、その後に呼び出されるextract()メソッドは、要素のデータ値のみを返すようになります。例えば、通常extract()はデータと優先度の両方を含む配列を返すことがありますが、この定数を設定すると、データ以外の情報を省いた、純粋なデータだけを受け取ることが可能です。

SplPriorityQueue::EXTR_DATA定数自体は引数を取らず、内部的には整数値（int）として定義されています。サンプルコードでは、キューに複数の要素とそれぞれの優先度を追加した後、setExtractFlags()でこの定数を設定しています。これにより、whileループ内でextract()メソッドが呼び出された際には、「りんご」「みかん」「バナナ」「ぶどう」といったデータのみが優先度順に出力されることを確認できます。これは、キューからデータのみを取り出したい場合に、処理を簡潔にするための便利な機能です。