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

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList::bottom() メソッドの使用例。
5 *
6 * SplDoublyLinkedList は、両端から要素を追加・削除できるリンクリストです。
7 * bottom() メソッドは、リストの先頭（一番下）の要素を返します。
8 * このメソッドはイテレータのポインタを移動させません。
9 *
10 * システムエンジニアを目指す初心者向けに、このメソッドの基本的な使い方を示します。
11 */
12function useSplDoublyLinkedListBottom(): void
13{
14    // SplDoublyLinkedList のインスタンスを作成
15    $list = new SplDoublyLinkedList();
16
17    // 1. 空のリストで bottom() を呼び出すと null が返ります
18    echo "1. 空のリストの bottom() : " . var_export($list->bottom(), true) . "\n\n";
19
20    // 2. リストに要素を追加 (push はリストの末尾に追加)
21    $list->push('First Item'); // これがリストの「一番底」の要素
22    $list->push('Second Item');
23    $list->push('Third Item'); // これがリストの「一番上」の要素
24    echo "2. 要素を追加しました: 'First Item', 'Second Item', 'Third Item'\n";
25    echo "   現在のリストの要素数: " . $list->count() . "\n\n";
26
27    // 3. bottom() メソッドを呼び出し、リストの先頭（一番底）の要素を取得
28    //    このメソッドはイテレータのポインタを移動させません。
29    $bottomElement = $list->bottom();
30    echo "3. bottom() メソッドで取得した要素: " . var_export($bottomElement, true) . "\n\n";
31
32    // 4. bottom() 呼び出し後のイテレータの状態を確認
33    //    bottom() はポインタに影響を与えないため、イテレータは初期状態のままです。
34    //    そのため、rewind() を呼び出してポインタを先頭に移動してから current() で要素を取得します。
35    $list->rewind();
36    echo "4. rewind() 後の現在の要素: " . var_export($list->current(), true) . "\n\n";
37
38    // 5. 参考: top() メソッドはリストの末尾（一番上）の要素を返します。
39    $topElement = $list->top();
40    echo "5. top() メソッドで取得した要素: " . var_export($topElement, true) . "\n";
41}
42
43// 関数の実行
44useSplDoublyLinkedListBottom();

PHP 8で利用できるSplDoublyLinkedListは、データの追加や削除をリストの両端から効率的に行える、いわゆる双方向リンクリストというデータ構造を提供します。このリストは、まるで積み重ねられた箱のように、一番下の要素から一番上の要素まで順序を持って管理されます。

SplDoublyLinkedList::bottom()メソッドは、このリストの「一番底」、つまり先頭に位置する要素を取得するために使用されます。このメソッドには引数を渡す必要がなく、リストの先頭の要素をmixed型で返します。もしリストが空の状態であれば、このメソッドはnullを返します。

サンプルコードでは、まず空のリストに対してbottom()を呼び出し、nullが返されることを確認しています。次に、「First Item」「Second Item」「Third Item」という順で要素を追加した場合、「First Item」がリストの先頭、つまり「一番底」の要素となります。ここでbottom()メソッドを呼び出すと、期待通り「First Item」が取得できます。

このメソッドの重要な特徴として、リスト内の現在のイテレータポインタの位置を移動させない点が挙げられます。そのため、bottom()を呼び出した後も、イテレータは以前の位置を保ったままです。対照的に、リストの末尾、つまり「一番上」の要素を取得したい場合は、top()メソッドを使用します。

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList::bottom() メソッドの使用例を示します。
5 * このメソッドは、双方向リンクリストの末尾（一番下の要素）を取得します。
6 * ウェブページの「スクロールして一番下へ」という動作とは直接関係ありませんが、
7 * データ構造における「一番下の要素」という意味で、キーワードの「bottom」と関連付けられます。
8 */
9function demonstrateSplDoublyLinkedListBottom(): void
10{
11    // SplDoublyLinkedList の新しいインスタンスを作成します。
12    // これは、要素を追加、削除、アクセスできるリストです。
13    $list = new SplDoublyLinkedList();
14
15    // リストに複数の要素を追加します。
16    // push() メソッドは、新しい要素をリストの末尾に追加します。
17    echo "リストに要素を追加します。\n";
18    $list->push("最初のアイテム");
19    $list->push("2番目のアイテム");
20    $list->push("3番目のアイテム");
21    $list->push("最後のアイテム"); // これがリストの末尾（bottom）の要素になります。
22    echo "現在のリストの要素数: " . $list->count() . "\n";
23
24    echo "----------------------------------------\n";
25
26    // bottom() メソッドを使用して、リストの末尾（一番最後の要素）を取得します。
27    // このメソッドは、リストの現在のイテレータの位置に関わらず、常に最後の要素を返します。
28    if (!$list->isEmpty()) {
29        $lastElement = $list->bottom();
30        echo "SplDoublyLinkedList::bottom() で取得された末尾の要素: '" . $lastElement . "'\n";
31    } else {
32        echo "リストが空のため、末尾の要素は存在しません。\n";
33    }
34
35    echo "----------------------------------------\n";
36
37    // リストが空の場合の bottom() の振る舞い（RuntimeExceptionをスローします）
38    // 通常は try-catch でハンドリングしますが、ここでは簡潔さのためコメントアウトします。
39    /*
40    $emptyList = new SplDoublyLinkedList();
41    try {
42        $emptyList->bottom();
43    } catch (RuntimeException $e) {
44        echo "空のリストで bottom() を呼び出すと例外が発生します: " . $e->getMessage() . "\n";
45    }
46    */
47}
48
49// 関数を実行して、SplDoublyLinkedList::bottom() の動作を確認します。
50demonstrateSplDoublyLinkedListBottom();
51

PHP 8のSplDoublyLinkedList::bottom()メソッドは、SplDouberlyLinkedListという特定のデータ構造に格納された要素のうち、最も末尾（一番最後の位置）にある要素を取得するために使用されます。SplDoublyLinkedListは、要素を順序付けて追加したり、取り出したりできるリストの一種です。

このbottom()メソッドは引数を一切取りません。呼び出すと、リストに最初に追加された要素ではなく、最後にpush()などの方法で追加された要素が返されます。戻り値の型はmixedであるため、リストに格納されている要素が文字列、数値、オブジェクトなど、どのような型であっても、その型のまま返されます。

ただし、リストが空の状態でbottom()メソッドを呼び出した場合、通常はRuntimeExceptionが発生しますので、このメソッドを使用する前には、isEmpty()メソッドなどでリストが空でないことを確認することをおすすめします。

「php scroll to bottom」というキーワードは、ウェブページなどのユーザーインターフェースを一番下までスクロールする動作を想像させるかもしれませんが、SplDoublyLinkedList::bottom()メソッドは、データ構造の「末尾の要素」を取得する機能であり、ウェブページのスクロール操作とは直接的な関連はありません。データ構造の最後の要素にアクセスするための操作として理解してください。