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

Copy
1<?php
2
3/**
4 * SplHeap::key() メソッドの使用例。
5 *
6 * SplHeap は抽象クラスなので、その具象子クラスである SplMinHeap を使用します。
7 * SplMinHeap は、挿入された要素の値をそのままキーとして扱うため、
8 * key() メソッドは top() メソッドと同じ値を返します。
9 *
10 * 'php key exists' というキーワードに対応するため、ヒープが空でないか（キーが存在し得るか）
11 * を確認してから key() メソッドを呼び出す例を示します。
12 */
13function demonstrateSplHeapKey(): void
14{
15    // SplMinHeap インスタンスを作成します。これは最小値が常にトップに来るヒープです。
16    $heap = new SplMinHeap();
17
18    echo "--- ヒープに要素を追加 ---\n";
19    $heap->insert(10); // 要素 10 を追加
20    $heap->insert(5);  // 要素 5 を追加 (これがトップになる)
21    $heap->insert(20); // 要素 20 を追加
22
23    echo "現在のヒープの要素数: " . $heap->count() . "\n\n";
24
25    // ヒープが空でないかを確認し、トップ要素のキーを取得します。
26    // SplHeap::isEmpty() を使用して、キーが存在し得るかどうかのチェックを行います。
27    if (!$heap->isEmpty()) {
28        echo "ヒープは空ではありません。トップ要素のキーを取得できます。\n";
29
30        // top() でトップ要素の値を取得します。
31        $topValue = $heap->top();
32        // key() でトップ要素のキーを取得します。
33        // SplMinHeap の場合、キーは値自体と同じです。
34        $topKey = $heap->key();
35
36        echo "トップ要素の値: " . $topValue . "\n";
37        echo "トップ要素のキー: " . $topKey . " (SplMinHeapでは値と同じ)\n\n";
38    } else {
39        echo "ヒープは空です。トップ要素のキーは存在しません。\n\n";
40    }
41
42    echo "--- トップ要素を一つ取り出す ---\n";
43    // extract() でトップ要素を取り除きます。
44    $extractedValue = $heap->extract();
45    echo "取り出した要素: " . $extractedValue . "\n";
46    echo "現在のヒープの要素数: " . $heap->count() . "\n\n";
47
48    // 再度、ヒープが空でないかを確認し、新しいトップ要素のキーを取得します。
49    if (!$heap->isEmpty()) {
50        echo "ヒープは空ではありません。新しいトップ要素のキーを取得できます。\n";
51
52        $newTopValue = $heap->top();
53        $newTopKey = $heap->key();
54
55        echo "新しいトップ要素の値: " . $newTopValue . "\n";
56        echo "新しいトップ要素のキー: " . $newTopKey . " (SplMinHeapでは値と同じ)\n\n";
57    } else {
58        echo "ヒープは空です。トップ要素のキーは存在しません。\n\n";
59    }
60
61    echo "--- 全ての要素を取り出し、ヒープを空にする ---\n";
62    while (!$heap->isEmpty()) {
63        $heap->extract();
64    }
65    echo "全ての要素を取り出しました。\n";
66    echo "現在のヒープの要素数: " . $heap->count() . "\n\n";
67
68    // ヒープが空になった場合のキーの存在チェック
69    if (!$heap->isEmpty()) {
70        // このブロックは実行されません
71        echo "ヒープは空ではありません。トップ要素のキーを取得できます。\n";
72    } else {
73        echo "ヒープは空です。トップ要素のキーは存在しません。したがって key() は呼び出せません。\n";
74        // 例えば、空のヒープに対して top() や key() を呼び出すと例外が発生します。
75        // echo $heap->top(); // RuntimeException: A heap is empty
76    }
77}
78
79// サンプル関数を実行
80demonstrateSplHeapKey();
81

PHPのSplHeap::key()メソッドは、現在ヒープの「トップ」にある要素のキーを返すために使われます。SplHeapは抽象クラスのため、サンプルコードではその具体的な実装であるSplMinHeapを使用しています。SplMinHeapは最小値をトップに保つヒープで、挿入された要素の「値」がそのまま「キー」として扱われるという特徴があります。このため、key()メソッドを呼び出すと、top()メソッドと同じ値が戻り値として返されます。

key()メソッドは引数を取りません。戻り値はmixed型で、これは様々なデータ型のキーが返される可能性があることを示します。

サンプルコードでは「php key exists」というキーワードに対応し、ヒープにキーが存在するかどうか、つまりヒープが空でないかを確認する重要性を示しています。$heap->isEmpty()メソッドを使ってヒープが空かどうかを事前にチェックすることで、空のヒープに対してkey()を呼び出して発生する可能性のあるエラー（RuntimeException）を防ぐことができます。

ヒープに要素を追加し、isEmpty()で空でないことを確認してからkey()を呼び出すことで、現在のトップ要素のキーを取得できます。要素を取り出した後も、同様にisEmpty()で確認することで、常に安全にキーの存在と値を取得できることを示しています。このように、SplHeap::key()はヒープの現在のトップ要素の識別子を知る上で役立つメソッドです。

Copy
1<?php
2
3/**
4 * SplHeap::key() メソッドの基本的な使い方を示すサンプルコードです。
5 * SplHeap は優先度キューの抽象基底クラスであり、key() メソッドは現在の要素の内部キーを返します。
6 * 通常、SplHeap の具体的な実装（例: SplMinHeap, SplMaxHeap）において、
7 * key() が返す値は、要素がヒープに挿入された順序に基づく整数値となります。
8 */
9function demonstrateSplHeapKey(): void
10{
11    // SplMinHeap (最小値ヒープ) のインスタンスを作成します。
12    // SplMinHeap は SplHeap の具象クラスの一つで、常に最も小さい要素が最上位に来るように維持します。
13    $heap = new SplMinHeap();
14
15    // ヒープに要素を挿入します。
16    // ここで挿入する順序（インデックス）と、後で key() が返す値の関係に注目してください。
17    // 'Banana' はインデックス 0 に、'Apple' はインデックス 1 に、'Cherry' はインデックス 2 に相当します。
18    $heap->insert('Banana');
19    $heap->insert('Apple');
20    $heap->insert('Cherry');
21
22    echo "--- ヒープの初期状態 ---" . PHP_EOL;
23
24    // 現在の要素（最も小さい要素）を表示します。
25    // SplMinHeapなので、辞書順で最も小さい 'Apple' がトップになります。
26    echo "現在のトップ要素: " . $heap->top() . PHP_EOL; // 出力: Apple
27
28    // 現在の要素に対応する内部キーを取得し、表示します。
29    // 'Apple' は2番目（インデックス1）に挿入されたため、キーは '1' となります。
30    echo "現在の要素のキー: " . $heap->key() . PHP_EOL; // 出力: 1
31
32    echo PHP_EOL;
33
34    // 最上位の要素を抽出（削除）します。
35    // これにより、次に小さい要素が新しいトップになります。
36    $extractedElement = $heap->extract();
37    echo "抽出された要素: " . $extractedElement . PHP_EOL; // 出力: Apple
38
39    echo PHP_EOL;
40
41    echo "--- 要素抽出後の状態 ---" . PHP_EOL;
42
43    // 抽出後の現在のトップ要素を表示します。
44    // 次に小さい 'Banana' が新しいトップになります。
45    echo "新しいトップ要素: " . $heap->top() . PHP_EOL; // 出力: Banana
46
47    // 新しいトップ要素に対応する内部キーを取得し、表示します。
48    // 'Banana' は1番目（インデックス0）に挿入されたため、キーは '0' となります。
49    echo "新しい要素のキー: " . $heap->key() . PHP_EOL; // 出力: 0
50
51    echo PHP_EOL;
52
53    // さらにもう一つ要素を抽出してみます。
54    $extractedElement = $heap->extract();
55    echo "抽出された要素: " . $extractedElement . PHP_EOL; // 出力: Banana
56
57    echo PHP_EOL;
58
59    echo "--- 2回目の要素抽出後の状態 ---" . PHP_EOL;
60
61    // 最終的に残ったトップ要素を表示します。
62    // 残る最後の要素である 'Cherry' がトップになります。
63    echo "最終的なトップ要素: " . $heap->top() . PHP_EOL; // 出力: Cherry
64
65    // 最終的なトップ要素に対応する内部キーを取得し、表示します。
66    // 'Cherry' は3番目（インデックス2）に挿入されたため、キーは '2' となります。
67    echo "最終的な要素のキー: " . $heap->key() . PHP_EOL; // 出力: 2
68}
69
70// 関数を実行して、SplHeap::key() の動作を確認します。
71demonstrateSplHeapKey();
72
73?>

PHPのSplHeap::key()メソッドは、優先度キューを実装するSplHeapの具象クラス（例えばSplMinHeapやSplMaxHeapなど）で利用され、現在ヒープの先頭にある要素の内部キーを返します。このメソッドは引数をとりません。戻り値の型はmixedで、通常はヒープに要素が挿入された順序を表す整数値となります。

サンプルコードでは、SplMinHeapに「Banana」「Apple」「Cherry」という順序で要素を挿入しています。SplMinHeapは最小の要素が常に先頭に来るため、最初にtop()メソッドで取得されるのは「Apple」です。このときkey()メソッドを呼び出すと、Appleが2番目（インデックス1）に挿入されたため「1」が返されます。

その後、extract()メソッドで「Apple」を抽出し削除すると、次に小さい「Banana」が新しい先頭要素になります。この状態でkey()を呼び出すと、Bananaが1番目（インデックス0）に挿入されたため「0」が返されます。さらに「Banana」を抽出すれば、残った「Cherry」が先頭となり、そのキーは3番目（インデックス2）に挿入されたため「2」を返します。このように、SplHeap::key()は、ヒープの構造に関わらず、要素が最初にヒープへ追加されたときの相対的な順序をキーとして提供する役割を持っています。