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

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList::valid() メソッドの使用例
5 *
6 * このスクリプトは、SplDoublyLinkedList のイテレータが有効な要素を指しているか
7 * どうかを検証する `valid()` メソッドの使い方を示します。
8 * `valid()` は、リストの反復処理中に現在のポインタが有効な位置にあるか
9 * 確認するために使用され、イテレータの状態の「有効性」をチェックします。
10 */
11
12// SplDoublyLinkedList のインスタンスを作成します。
13$myList = new SplDoublyLinkedList();
14
15echo "--- リストに要素を追加 ---" . PHP_EOL;
16$myList->push('Apple');
17$myList->push('Banana');
18$myList->push('Cherry');
19echo "現在のリストの要素数: " . $myList->count() . PHP_EOL . PHP_EOL;
20
21// イテレータをリストの先頭にリセットします。
22// `valid()` メソッドはイテレータの現在位置に対して機能するため、
23// 反復処理を開始する前にポインタをリセットすることが重要です。
24$myList->rewind();
25
26echo "--- リストを反復処理し、valid() で有効性をチェック ---" . PHP_EOL;
27
28// `valid()` メソッドは、現在のイテレータが有効な要素を指している場合に `true` を返します。
29// これにより、リストの末尾に到達したことを安全に検出できます。
30while ($myList->valid()) {
31    $currentItem = $myList->current();
32    echo "現在の要素が有効です (valid() -> " . ($myList->valid() ? 'true' : 'false') . "): " . $currentItem . PHP_EOL;
33    $myList->next(); // 次の要素へポインタを進めます。
34}
35
36echo PHP_EOL . "--- 反復処理が終了 ---" . PHP_EOL;
37
38// ループ終了後、ポインタはリストの末尾を超えているため、`valid()` は `false` を返します。
39echo "反復処理後、現在の要素は無効です (valid() -> " . ($myList->valid() ? 'true' : 'false') . "). " .
40     "これは、すべての要素を処理し終えたことを意味します。" . PHP_EOL;
41
42echo PHP_EOL . "--- 空のリストでの valid() の動作 ---" . PHP_EOL;
43$emptyList = new SplDoublyLinkedList();
44// 空のリストの場合、`rewind()` 後でも `valid()` は `false` を返します。
45$emptyList->rewind();
46echo "空のリストの場合、valid() -> " . ($emptyList->valid() ? 'true' : 'false') . PHP_EOL;
47

PHPのSplDoublyLinkedList::valid()メソッドは、両方向連結リスト（SplDoublyLinkedList）の要素を反復処理する際に、現在イテレータが指している位置が有効な要素であるかを確認するために使用されます。このメソッドは引数を取らず、真偽値（bool）を戻り値として返します。

リストの要素を順に処理する間、現在のポインタが有効な要素を指している場合はtrueを返します。これにより、まだ処理すべき要素が残っているかを確認できます。一方、ポインタがリストの末尾を超えて要素が存在しない位置を指している場合や、リストが空の場合にはfalseを返します。

サンプルコードでは、while ($myList->valid())というループ条件でこのメソッドが活用されています。rewind()でリストの先頭にポインタをリセットした後、valid()がtrueを返している間はループ内の処理を続行し、next()で次の要素へ進めます。そして、すべての要素を処理し終えてvalid()がfalseを返すと、ループが安全に終了します。このように、valid()メソッドはリストの反復処理において、現在のポインタの有効性を検証し、処理の継続または終了を制御するために非常に重要な役割を果たします。

Copy
1<?php
2
3/**
4 * SplDoublyLinkedList のイテレータが有効な位置にあるかを確認するサンプル。
5 *
6 * SplDoublyLinkedList::valid() メソッドは、イテレータがリストの有効な要素を指しているか
7 * どうかをブール値で返します。これにより、リストの要素を順に処理する際に、現在の位置が
8 * 終端に達していないか、またはリストが空でないかを確認できます。
9 * これは、リストの要素の「有効性」を検証する一つの形と言えます。
10 */
11function processAndValidateDoublyLinkedList(): void
12{
13    // SplDoublyLinkedList のインスタンスを作成
14    $list = new SplDoublyLinkedList();
15
16    // リストに要素を追加
17    $list->push('Item A');
18    $list->push('Item B');
19    $list->push('Item C');
20
21    echo "--- SplDoublyLinkedList の要素を順に処理します ---\n";
22
23    // イテレータをリストの先頭に巻き戻します。
24    // valid() を使用する前に、イテレータの位置を初期化することが重要です。
25    $list->rewind();
26
27    // イテレータが有効な位置を指している間（すなわち、リストの終端に達していない間）ループを続行します。
28    while ($list->valid()) {
29        // 現在の要素を取得し、出力します。
30        echo "現在の要素: " . $list->current() . "\n";
31
32        // イテレータを次の要素に進めます。
33        $list->next();
34    }
35
36    echo "--- リストの処理が完了しました ---\n\n";
37
38    // ループ終了後、イテレータはリストの終端にあるため、valid() は false を返します。
39    echo "valid() メソッドが false を返す例:\n";
40    if (!$list->valid()) {
41        echo "  - イテレータは現在、有効な要素を指していません (リストの終端)。\n";
42    }
43
44    // 空のリストの場合の valid() の動作を確認します。
45    $emptyList = new SplDoublyLinkedList();
46    $emptyList->rewind(); // 空のリストでも rewind は実行可能ですが、イテレータは有効な位置を持ちません。
47    if (!$emptyList->valid()) {
48        echo "  - 空のリストの場合も、イテレータは有効な要素を指していません。\n";
49    }
50}
51
52// 関数を実行して、SplDoublyLinkedList::valid() の動作を確認します。
53processAndValidateDoublyLinkedList();

PHPのSplDoublyLinkedList::valid()メソッドは、リストの要素を順に処理する際に、現在注目している位置（イテレータ）が、有効な要素を指しているかどうかを真偽値（trueまたはfalse）で確認するためのものです。このメソッドは引数を必要としません。

サンプルコードでは、まずSplDoublyLinkedListに複数の要素を追加しています。その後、リストの先頭にイテレータを戻すrewind()メソッドを実行し、while ($list->valid())という条件でループを開始しています。これにより、イテレータが有効な要素を指している間だけ、ループが繰り返し実行されます。ループ内部では、current()で現在の要素を取得し、next()で次の要素へとイテレータを進めていきます。

リストの終端に達したり、リストが元々空だったりする場合には、valid()メソッドはfalseを返します。これは、もう処理すべき有効な要素が存在しないことを示しており、ループを安全に終了させるために利用されます。このように、valid()メソッドは、リストの要素を確実に、かつ適切に最後まで処理するために重要な役割を果たします。