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

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList クラスの top() メソッドの使用例を示します。
5 *
6 * SplDoublyLinkedList は、両端から要素を追加・削除できるリストです。
7 * top() メソッドは、リストの「最上位」（最後にプッシュされた要素）を取得します。
8 * これはスタックデータ構造における「peek」操作に相当し、要素はリストから削除されません。
9 */
10function demonstrateSplDoublyLinkedListTop(): void
11{
12    // SplDoublyLinkedList の新しいインスタンスを作成します。
13    // これをスタック（後入れ先出し）のように利用します。
14    $stack = new SplDoublyLinkedList();
15
16    echo "--- 初期状態 ---" . PHP_EOL;
17    // リストが空かどうかを確認します。
18    echo "リストは空か？ " . ($stack->isEmpty() ? 'はい' : 'いいえ') . PHP_EOL;
19
20    // 要素をリストの末尾（スタックの最上位）に追加します。
21    // push() はスタックに要素を積む操作に相当します。
22    $stack->push('First item (pushed)');
23    $stack->push('Second item (pushed)');
24    $stack->push('Third item (pushed)');
25
26    echo PHP_EOL . "--- 要素追加後 ---" . PHP_EOL;
27    // 現在のリストの内容をイテレートして表示します。
28    // SplDoublyLinkedList はイテレータとして機能します。
29    echo "リストの内容 (bottomからtopへ): ";
30    foreach ($stack as $item) {
31        echo "'" . $item . "' ";
32    }
33    echo PHP_EOL;
34
35    // top() メソッドを使用して、リストの最上位要素（最後に追加された要素）を取得します。
36    // top() は要素をリストから削除せず、その値だけを返します。
37    // リストが空の場合に top() を呼び出すと RuntimeException が発生するため、
38    // 事前に isEmpty() で確認することが推奨されます。
39    if (!$stack->isEmpty()) {
40        $topElement = $stack->top();
41        echo "リストの最上位要素 (top()): '" . $topElement . "'" . PHP_EOL;
42    } else {
43        echo "リストが空のため、top() は呼び出せません。" . PHP_EOL;
44    }
45
46    // top() を呼び出した後も要素がリストに残っていることを確認します。
47    echo "top() 呼び出し後のリストのサイズ: " . $stack->count() . PHP_EOL;
48
49    // リストから要素を削除する pop() メソッドの例（参考）
50    $poppedElement = $stack->pop();
51    echo "pop() で削除された要素: '" . $poppedElement . "'" . PHP_EOL;
52    echo "pop() 後のリストのサイズ: " . $stack->count() . PHP_EOL;
53
54    // pop() 後、新しい top() 要素を確認します。
55    if (!$stack->isEmpty()) {
56        $newTopElement = $stack->top();
57        echo "pop() 後、新しい最上位要素 (top()): '" . $newTopElement . "'" . PHP_EOL;
58    }
59
60    echo PHP_EOL . "--- 空のリストでの top() ---" . PHP_EOL;
61    $emptyStack = new SplDoublyLinkedList();
62    echo "空のリストは空か？ " . ($emptyStack->isEmpty() ? 'はい' : 'いいえ') . PHP_EOL;
63    if (!$emptyStack->isEmpty()) {
64        // このコードブロックは実行されません
65        $emptyStack->top();
66    } else {
67        echo "空のリストで top() を直接呼び出すと RuntimeException が発生する可能性があります。" . PHP_EOL;
68        echo "そのため、常に isEmpty() でリストが空でないことを確認してから呼び出しましょう。" . PHP_EOL;
69    }
70}
71
72// 関数を実行して、SplDoublyLinkedList::top() の動作を確認します。
73demonstrateSplDoublyLinkedListTop();

PHP 8のSplDoublyLinkedListは、両端から要素を追加・削除できる特別なリスト構造です。これは、スタック（後入れ先出し）やキュー（先入れ先出し）のようにデータを扱う際に便利に使えます。

このクラスのtop()メソッドは、リストの「最上位」に位置する要素、つまり最後にリストへ追加（プッシュ）された要素を取得するために使用されます。これはスタックデータ構造における「peek」操作に相当し、要素を取得するだけでリストから削除は行いません。

top()メソッドは引数を必要とせず、最上位要素の値をそのまま返します。戻り値の型はmixedであり、リストに格納された任意の型のデータを受け取ることが可能です。ただし、top()メソッドを空のリストに対して呼び出すと、RuntimeExceptionが発生する可能性があります。そのため、top()を呼び出す前に、isEmpty()メソッドを使ってリストが空でないことを確認することが非常に重要です。

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList を使用して、リストの末尾（top）要素をUSDに変換するサンプルコード。
5 *
6 * この関数は、いくつかの仮想的な価格（PHP通貨単位）をリストに追加し、
7 * SplDoublyLinkedList::top() メソッドを使ってリストの末尾要素を取得し、
8 * その価格をUSDに換算して表示します。
9 */
10function convertPhpToUsdFromListTop(): void
11{
12    // SplDoublyLinkedList のインスタンスを作成
13    // これは双方向連結リストとして機能し、要素の追加や削除を効率的に行えます。
14    $priceList = new SplDoublyLinkedList();
15
16    // リストにいくつかの仮想的な商品価格（PHP通貨単位）を追加します。
17    // push() メソッドはリストの末尾に要素を追加します。
18    $priceList->push(500.00);  // 書籍の価格
19    $priceList->push(120.50);  // オンラインコースの一部
20    $priceList->push(800.75);  // 開発ツールのサブスクリプション費用
21
22    echo "--- リストに追加された価格 (PHP通貨単位) ---\n";
23    // イテレータを使用してリストの全要素を表示
24    foreach ($priceList as $price) {
25        echo "価格: " . $price . " PHP\n";
26    }
27    echo "------------------------------------------\n\n";
28
29    // リストが空でないことを確認します。
30    // 空の場合に top() を呼び出すと RuntimeException がスローされる可能性があります。
31    if ($priceList->isEmpty()) {
32        echo "リストは空です。先頭/末尾の要素を取得できません。\n";
33        return;
34    }
35
36    // top() メソッドを使用してリストの「末尾」の要素を取得します。
37    // SplDoublyLinkedList において top() は、最後に push された要素、つまりリストの末尾の要素を返します。
38    // bottom() は最初の要素を返します。
39    $priceInPhp = $priceList->top();
40
41    // USD への為替レートを設定します (例として 1 PHP = 0.018 USD)。
42    // 実際のアプリケーションでは、外部APIなどから最新の為替レートを取得します。
43    $exchangeRatePhpToUsd = 0.018;
44
45    // PHP から USD へと価格を変換します。
46    $convertedPriceUsd = $priceInPhp * $exchangeRatePhpToUsd;
47
48    echo "SplDoublyLinkedList::top() で取得された価格: " . $priceInPhp . " PHP\n";
49    echo "使用した為替レート (1 PHP = " . $exchangeRatePhpToUsd . " USD)\n";
50    echo "USD に変換された価格: " . sprintf("%.2f", $convertedPriceUsd) . " USD\n";
51}
52
53// 定義した関数を実行します。
54convertPhpToUsdFromListTop();
55

PHP 8におけるSplDoublyLinkedList::top()メソッドは、PHPの標準拡張機能の一つで、双方向連結リストであるSplDoublyLinkedListクラスに属します。このクラスは、要素の追加や削除を効率的に行えるデータ構造を提供します。

top()メソッドは、引数を一切取らず、リストの「末尾」に位置する要素を返します。ここでいう末尾とは、push()メソッドで最後にリストに追加された要素のことです。戻り値の型はmixedであるため、数値、文字列、オブジェクトなど、リストに格納されたあらゆる型の要素を受け取ることができます。

提供されたサンプルコードでは、まずSplDoublyLinkedListのインスタンスを作成し、push()メソッドを使って複数の仮想的な商品価格（PHP通貨単位）をリストの末尾に順番に追加しています。その後、isEmpty()メソッドでリストが空でないことを確認してからtop()を呼び出しています。これは、リストが空の状態でtop()を呼び出すとRuntimeExceptionが発生する可能性があるため、エラー回避のために推奨される手順です。

top()メソッドによって取得された最も新しい価格（末尾の要素）は、為替レートを用いてPHPからUSDへと変換され、結果が表示されます。この例は、top()メソッドがどのようにリストの特定の要素にアクセスし、その値を活用できるかを示す具体的な応用例となっています。