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

Copy
1<?php
2
3// SplMinHeap は、最小値が常に頂点にあるヒープ（優先度キュー）を実装するクラスです。
4// key() メソッドは、イテレーション中に現在の要素の「位置」を示す整数を返します。
5// これは配列のキーのように値を識別するものではなく、ヒープ内部でのイテレーション順序におけるインデックスを指します。
6
7// SplMinHeap のインスタンスを作成します。
8$heap = new SplMinHeap();
9
10echo "--- ヒープに要素を追加する前 ---" . PHP_EOL;
11// ヒープが空の場合、valid() メソッドは false を返します。
12// valid() が false のときに key() を呼び出すのは通常避けるべきです。
13if (!$heap->valid()) {
14    echo "ヒープは空です。現在の要素のキーは存在しません。" . PHP_EOL;
15}
16
17echo PHP_EOL;
18
19echo "--- ヒープに要素を追加 ---" . PHP_EOL;
20$heap->insert(10); // 値 10 をヒープに挿入
21$heap->insert(5);  // 値 5 をヒープに挿入 (最小値なので頂点になる可能性が高い)
22$heap->insert(20); // 値 20 をヒープに挿入
23
24echo "ヒープの現在の要素数: " . $heap->count() . PHP_EOL;
25
26echo PHP_EOL;
27
28echo "--- ヒープをイテレートし、現在の要素のキーと値を取得 ---" . PHP_EOL;
29// ヒープをイテレート（走査）する前に、rewind() メソッドを呼び出して内部ポインタを最初の要素にリセットします。
30$heap->rewind();
31
32// valid() メソッドで、現在の位置に要素が存在するか（イテレーション可能なキーが存在するか）を確認します。
33// これが 'php key exists' というキーワードに関連するチェックとなります。
34while ($heap->valid()) {
35    // current() メソッドで現在の要素の値を取得します。
36    $currentValue = $heap->current();
37    // key() メソッドで現在の要素の「位置」（インデックス）を取得します。
38    // このキーはヒープが内部的に管理する整数値で、0 から始まります。
39    $currentKey = $heap->key();
40
41    echo "現在の要素 (内部キー: {$currentKey}, 値: {$currentValue})" . PHP_EOL;
42
43    // next() メソッドで内部ポインタを次の要素に進めます。
44    $heap->next();
45}
46
47echo PHP_EOL;
48
49echo "--- ヒープからすべての要素を取り出した後 ---" . PHP_EOL;
50// isEmpty() メソッドでヒープが空かどうかを確認し、extract() で要素をすべて取り出します。
51while (!$heap->isEmpty()) {
52    $heap->extract(); // 最小要素を取り出す
53}
54
55echo "ヒープは空になりました。要素数: " . $heap->count() . PHP_EOL;
56
57// すべての要素を取り出した後、再び valid() で要素の存在を確認します。
58if (!$heap->valid()) {
59    echo "ヒープは空なので、現在の要素を示すキーは存在しません。" . PHP_EOL;
60}

SplMinHeapは、常に最小値が一番上に来るように要素を管理する「ヒープ（優先度キュー）」というデータ構造を提供するPHPのクラスです。その中でkey()メソッドは、ヒープの要素を一つずつ順番に処理する「イテレーション」中に、現在注目している要素の「内部的な位置」を示す整数を返します。このメソッドは引数を持たず、必ず整数値（int）を戻り値として返します。

この「キー」は、配列のインデックスのように0から始まる連番ですが、あくまでヒープの内部的なイテレーション順序における位置であり、要素の値そのものを識別するものではありません。サンプルコードでは、まずヒープが空の場合、valid()メソッドで現在の要素が存在しないことを確認します。valid()がfalseのときにkey()を呼び出すと意味がありません。

要素をヒープに追加した後、rewind()でイテレーションの開始位置にポインタをリセットし、while ($heap->valid())のループでヒープ内の各要素を順番に処理します。このvalid()メソッドによる確認が、php key existsという概念に近く、現在のイテレーション位置に有効な要素（およびそれに対応するキー）が存在するかを判断する役割を果たします。ループ内でkey()を呼び出すことで、現在の要素の内部インデックスを取得し、current()で値を取得します。next()で次の要素へ移動します。全ての要素を取り出した後は、再びvalid()がfalseとなり、現在の要素を示すキーが存在しない状態に戻ります。

Copy
1<?php
2
3/**
4 * SplMinHeap から要素と対応するキー（イテレータのインデックス）を取得するサンプル関数
5 *
6 * SplMinHeap は、最小値が常に先頭に来るように要素を格納するヒープデータ構造です。
7 * key() メソッドは、現在のイテレータ位置に対応する整数キー（インデックス）を返します。
8 * これは、要素自体に付随する「キー」ではなく、ヒープをイテレートした際の順序を示すものです。
9 */
10function demonstrateSplMinHeapKey(): void
11{
12    // SplMinHeap のインスタンスを作成
13    $minHeap = new SplMinHeap();
14
15    // ヒープに複数の要素を追加
16    // 追加順序に関わらず、SplMinHeap は内部で要素をソートし、最小のものが常に先頭に来るようにします。
17    $minHeap->insert(30);
18    $minHeap->insert(10);
19    $minHeap->insert(20);
20    $minHeap->insert(5);  // この値が最も小さい
21    $minHeap->insert(25);
22
23    echo "SplMinHeap の要素をイテレートし、値とキー（インデックス）を表示します。\n";
24    echo "注意: key() はイテレータの順序を示すインデックスであり、要素の識別子ではありません。\n\n";
25
26    // イテレータを先頭にリセット
27    // これにより、最初にアクセスされる要素のキー（インデックス）は 0 になります。
28    $minHeap->rewind();
29
30    // ヒープが有効な要素を持つ間、ループを続行
31    while ($minHeap->valid()) {
32        // 現在のイテレータ位置の要素の値を取得
33        // SplMinHeap の場合、current() は現在最も小さい（または次に小さい）要素の値を返します。
34        $currentValue = $minHeap->current();
35
36        // 現在のイテレータ位置のキー（インデックス）を取得
37        // key() は、要素が取り出される順序に対応する整数インデックス (0, 1, 2...) を返します。
38        $currentKey = $minHeap->key();
39
40        echo "キー (イテレータインデックス): " . $currentKey . ", 値: " . $currentValue . "\n";
41
42        // イテレータを次の要素に進める
43        // 次の smallest (または次に小さい) 要素に移動します。
44        $minHeap->next();
45    }
46
47    echo "\nヒープの要素は小さい順にイテレートされました。\n";
48    echo "key() はそのイテレート順のインデックスを示しています。\n";
49}
50
51// サンプル関数を実行
52demonstrateSplMinHeapKey();
53

PHPのSplMinHeapクラスは、常に最小の要素が先頭になるようにデータを自動的に整理してくれる、特殊なデータ構造です。このSplMinHeapが提供するkey()メソッドは、現在イテレータが指している要素が「何番目」に処理されているかを示す整数値（インデックス）を取得します。

このメソッドには引数を渡す必要がなく、呼び出すと現在のイテレータ位置に対応するint型のインデックスが戻り値として返されます。例えば、SplMinHeapに複数の数値を挿入した後、rewind()メソッドでイテレータを先頭に戻し、whileループで順に要素をたどっていく場合、key()は最初の要素で0、次の要素で1、その次で2といったように、要素が取り出される順番に合わせたインデックスを返します。

これは、ヒープ内の要素自体に付けられた固有の識別子（キー）ではなく、あくまで要素を小さい順に巡っていく「イテレータの現在位置」を示す番号です。key()を使うことで、SplMinHeapから要素を取り出す際に、それが何番目の要素として処理されたのかを確認することができます。