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

Copy
1<?php
2
3/**
4 * SplMinHeap::top() メソッドの使用例を示します。
5 * ヒープに要素を追加し、最小値を取り出さずに参照する方法を実演します。
6 */
7function demonstrateSplMinHeapTopUsage(): void
8{
9    // SplMinHeap の新しいインスタンスを作成します。
10    // これは最小要素が常にトップにある優先度キューとして機能します。
11    $heap = new SplMinHeap();
12
13    // いくつかの要素をヒープに挿入します。
14    // 挿入順序は自由ですが、top() は常に最小値を提供します。
15    echo "ヒープに要素を挿入: 5, 2, 8, 1, 10" . PHP_EOL;
16    $heap->insert(5);
17    $heap->insert(2);
18    $heap->insert(8);
19    $heap->insert(1);
20    $heap->insert(10);
21
22    // top() メソッドを使用して、ヒープの現在の最小要素を参照します。
23    // このメソッドは要素を返しますが、ヒープからは削除しません。
24    if (!$heap->isEmpty()) {
25        $currentMin = $heap->top();
26        echo "現在のヒープの最小要素 (top()): " . $currentMin . PHP_EOL; // 期待値: 1
27    } else {
28        echo "ヒープは空です。" . PHP_EOL;
29    }
30
31    echo PHP_EOL; // 出力を見やすくするための改行
32
33    // extract() メソッドを使用して、ヒープの最小要素を取り出します（削除します）。
34    if (!$heap->isEmpty()) {
35        $removedElement = $heap->extract();
36        echo "ヒープから取り出した要素 (extract()): " . $removedElement . PHP_EOL; // 期待値: 1
37    } else {
38        echo "ヒープは空のため、要素を取り出せません。" . PHP_EOL;
39    }
40
41    // 要素を取り出した後、再度 top() で新しい最小要素を確認します。
42    // 最小要素が削除されたため、次の最小要素がトップになります。
43    if (!$heap->isEmpty()) {
44        $newMin = $heap->top();
45        echo "要素取り出し後の新しい最小要素 (top()): " . $newMin . PHP_EOL; // 期待値: 2
46    } else {
47        echo "ヒープは空です。" . PHP_EOL;
48    }
49}
50
51// サンプル関数を実行します。
52demonstrateSplMinHeapTopUsage();
53

SplMinHeap::top()メソッドは、PHPの標準ライブラリ（SPL）に含まれるSplMinHeapクラスの機能です。SplMinHeapは、最小要素が常に一番上（トップ）にあるように要素を自動的に整理する、優先度キューの一種です。

このサンプルコードでは、まずSplMinHeapのインスタンスを作成し、複数の数値をヒープに挿入しています。具体的には「5, 2, 8, 1, 10」という要素が追加されます。

次に、top()メソッドを呼び出し、ヒープ内の現在の最小要素を参照します。このメソッドは引数を取らず、ヒープから要素を削除することなく、最も小さい要素（この場合は「1」）を戻り値として返します。

その後、extract()メソッドを使用して最小要素「1」をヒープから取り除きます。extract()は要素を削除して返す点がtop()と異なります。

最後に、要素が一つ削除された後で再度top()メソッドを呼び出し、ヒープ内の新しい最小要素（この場合は「2」）が参照できることを確認しています。

このように、top()メソッドは、ヒープの構造に影響を与えずに、現在の最小要素を安全に確認したい場合に利用できる、非常に便利な機能です。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * PHPをUSDに変換する際の、複数のサービスプロバイダーから最も低コストのオプションを見つけるサンプルコードです。
7 * SplMinHeap::top() メソッドを使用して、ヒープの最小要素（最低コストのサービス）を取得します。
8 *
9 * @return void
10 */
11function findLowestCostPhpToUsdConversion(): void
12{
13    // SplMinHeapは常に最小要素をルートに保持するヒープデータ構造です。
14    // デフォルトでは、PHPの比較演算子に基づいて要素を比較します。
15    // ここでは連想配列を格納しており、PHPは配列の最初の要素から順に比較するため、
16    // 'cost' キーの値が最も小さいものが「最小」と判断されます。
17    $conversionOptions = new SplMinHeap();
18
19    // 複数のPHP-USD変換オプションとそれぞれの仮想的な手数料（コスト）を追加します。
20    // キーワード 'php to usd' に関連するシナリオとして、最も良い変換レート（低コスト）を探します。
21    $conversionOptions->insert(['cost' => 0.025, 'provider' => 'ExchangePro']);
22    $conversionOptions->insert(['cost' => 0.018, 'provider' => 'GlobalMoney']); // 最も低いコスト
23    $conversionOptions->insert(['cost' => 0.030, 'provider' => 'FastCashEx']);
24    $conversionOptions->insert(['cost' => 0.020, 'provider' => 'SecurePay']);
25
26    echo "PHPからUSDへの変換オプションを評価しています...\n";
27
28    // ヒープに要素があるか確認します。
29    if ($conversionOptions->isEmpty()) {
30        echo "変換オプションが見つかりませんでした。\n";
31        return;
32    }
33
34    // top() メソッドを使用して、ヒープの最小要素（最もコストの低いオプション）を取得します。
35    // このメソッドは要素をヒープから削除せずにその値を返します。
36    // 戻り値は mixed 型で、ここでは連想配列が返されます。
37    $lowestCostOption = $conversionOptions->top();
38
39    echo "----------------------------------------\n";
40    echo "最も低コストなPHP-USD変換オプション:\n";
41    echo "プロバイダー: " . $lowestCostOption['provider'] . "\n";
42    echo "手数料: " . sprintf('%.3f', $lowestCostOption['cost']) . " USD\n";
43    echo "----------------------------------------\n";
44
45    // top() メソッドは要素を削除しないため、何度呼び出しても同じ最小要素を返します。
46    // 例えば、もう一度最小要素を確認してみます。
47    echo "\n(参考) もう一度 top() を呼び出しても、同じ最小要素が返されます:\n";
48    $sameLowestCostOption = $conversionOptions->top();
49    echo "プロバイダー: " . $sameLowestCostOption['provider'] . "\n";
50    echo "手数料: " . sprintf('%.3f', $sameLowestCostOption['cost']) . " USD\n";
51}
52
53// 関数を実行してサンプルコードの動作を確認します。
54findLowestCostPhpToUsdConversion();

PHP 8のSplMinHeap::top()メソッドは、ヒープデータ構造であるSplMinHeapオブジェクトに格納された要素の中で、最も小さい（優先度の高い）要素を取得するために使用されます。このメソッドは、ヒープから要素を削除せずにその値を参照できる点が特徴です。

サンプルコードでは、「PHPをUSDに変換するサービス」の最も低コストなオプションを見つけるシナリオで活用されています。複数の変換プロバイダーのコスト情報がSplMinHeapにinsert()されており、SplMinHeapはデフォルトでコストが低いものを「最小」として自動的に整理します。

top()メソッドは引数を必要としません。ヒープのルートに位置する最小要素（この場合は最低コストのサービス情報を含む連想配列）を直接返します。戻り値の型はmixedで、どのような型の要素が格納されていても、その最小要素の値をそのまま返します。サンプルコードでは、['cost' => 0.018, 'provider' => 'GlobalMoney']という形式の連想配列が返され、最も有利なオプションを簡単に特定できます。top()を複数回呼び出してもヒープの内容は変わらないため、常に同じ最小要素が取得され、ヒープの状態を変更することなく現在の最小値を安全に確認できます。