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

Copy
1<?php
2
3// SplStack は、LIFO (Last-In, First-Out: 後入れ先出し) の原則で動作するスタックデータ構造を提供します。
4// このクラスは Countable インターフェースを実装しているため、
5// そのインスタンスの要素数を取得するために SplStack::count() メソッド、
6// またはグローバルな count() 関数を使用することができます。
7
8// 新しい SplStack インスタンスを作成します。
9$stack = new SplStack();
10
11echo "スタック初期化後の要素数 (SplStack::count()): " . $stack->count() . "\n";
12echo "スタック初期化後の要素数 (グローバル count()): " . count($stack) . "\n\n";
13
14// スタックに要素を追加します (push 操作)。
15$stack->push("データA");
16$stack->push("データB");
17$stack->push("データC");
18
19echo "要素追加後の要素数 (SplStack::count()): " . $stack->count() . "\n";
20echo "要素追加後の要素数 (グローバル count()): " . count($stack) . "\n\n";
21
22// スタックから要素を削除します (pop 操作)。
23// pop はスタックの「一番上」（最後に追加された要素）を取り出します。
24$poppedItem = $stack->pop();
25echo "取り除かれた要素: " . $poppedItem . "\n"; // 'データC' が取り出されます
26
27echo "要素削除後の要素数 (SplStack::count()): " . $stack->count() . "\n";
28echo "要素削除後の要素数 (グローバル count()): " . count($stack) . "\n\n";
29
30// さらに要素を追加して、再度要素数を確認します。
31$stack->push("データD");
32echo "追加後の要素数 (SplStack::count()): " . $stack->count() . "\n";
33
34?>

SplStack::count() メソッドは、PHP 8で提供されるSplStackクラスのインスタンスに現在格納されている要素の総数を取得するために使われます。SplStackは、最後に格納された要素が最初に取り出される「後入れ先出し（LIFO: Last-In, First-Out）」の原則で動作するスタックデータ構造を提供します。このcount()メソッドは引数を一切必要とせず、スタック内の要素数を整数型（int）で返します。

SplStackクラスはPHPの標準インターフェースであるCountableを実装しているため、オブジェクト指向の形式で$stack->count()としてメソッドを呼び出す方法と、PHPのグローバルなcount($stack)関数を使用する両方で、同じ要素数を取得できます。

サンプルコードでは、まず新しいSplStackインスタンスを初期化すると、要素数が0であることが示されます。その後、pushメソッドを使って「データA」「データB」「データC」と要素を順番に追加していくと、count()メソッドの戻り値は適切に3に増加します。さらに、popメソッドでスタックの一番上にある要素（この場合は「データC」）を取り除くと、count()メソッドの戻り値は2に減少します。このように、SplStack::count()メソッドは、スタックの動的な要素数の変化を正確に把握し、プログラム内でデータ構造の状態を管理する上で非常に有用です。

Copy
1<?php
2
3/**
4 * SplStack::count() メソッドの使用例
5 *
6 * SplStack はLIFO (Last In, First Out) の原則に従うスタックデータ構造を実装します。
7 * count() メソッドは、スタック内の要素の総数を返します。
8 * この例では、null値を含む要素がどのようにカウントされるかを示します。
9 */
10
11// SplStackの新しいインスタンスを作成します。
12$stack = new SplStack();
13
14// スタックが空の場合の要素数を確認します。
15echo "初期状態のスタックの要素数: " . $stack->count() . PHP_EOL; // 期待値: 0
16
17// さまざまな型の要素をスタックに追加します。
18$stack->push("First item");
19$stack->push(123);
20$stack->push(true);
21$stack->push(null); // null値の要素を追加。count()はこれを1つの有効な要素として数えます。
22$stack->push("Last item");
23
24// 要素を追加した後のスタックの要素数を確認します。
25echo "要素追加後のスタックの要素数: " . $stack->count() . PHP_EOL; // 期待値: 5
26
27// スタックから要素を1つ取り出します（LIFOの原則により "Last item" が取り出されます）。
28$poppedElement = $stack->pop();
29echo "ポップされた要素: " . var_export($poppedElement, true) . PHP_EOL;
30
31// 1つ要素を取り出した後のスタックの要素数を確認します。
32echo "1つ要素をポップした後のスタックの要素数: " . $stack->count() . PHP_EOL; // 期待値: 4
33
34// もう1つ要素を取り出します（nullが取り出されます）。
35$poppedNullElement = $stack->pop();
36echo "ポップされた要素 (null): " . var_export($poppedNullElement, true) . PHP_EOL;
37
38// null要素を取り出した後のスタックの要素数を確認します。
39echo "null要素をポップした後のスタックの要素数: " . $stack->count() . PHP_EOL; // 期待値: 3
40
41// スタック内のすべての要素を取り出し、最終的な要素数を確認します。
42while (!$stack->isEmpty()) {
43    $stack->pop();
44}
45
46echo "すべての要素をポップした後のスタックの要素数: " . $stack->count() . PHP_EOL; // 期待値: 0
47
48?>

SplStack::count()メソッドは、PHP 8で利用できるSplStackクラスに所属し、スタックに現在格納されている要素の総数を取得するために使用します。SplStackは、LIFO（Last In, First Out、最後に入れたものが最初に出る）の原則に従うデータ構造であるスタックを実装しています。

このメソッドは引数を取りません。戻り値は整数型（int）で、スタック内の要素数を返します。

サンプルコードでは、まず空のスタックを作成し、その際の要素数が0であることをcount()で確認しています。その後、文字列、数値、真偽値、そしてnull値など、さまざまな型の要素をpushメソッドでスタックに追加しています。ここで重要なのは、null値も他のデータ型と同様に1つの有効な要素としてカウントされる点です。要素追加後には、nullを含むすべての要素が数えられ、正確な要素数が返されます。

さらに、popメソッドでスタックから要素を取り出すと、そのたびにcount()メソッドが返す要素数が減少していくことが示されています。特に、null要素を取り出した後も、count()は残りの要素数を正しく返します。このようにcount()メソッドは、スタックがどのような状態であっても、現在の要素数を正確に把握するための基本的な手段となります。