【PHP8.x】Random\Engine\Xoshiro256StarStar::__construct()メソッドの使い方

Copy
1<?php
2
3/**
4 * Random\Engine\Xoshiro256StarStar クラスのコンストラクタ使用例
5 *
6 * このクラスは、PHP 8.2 以降で利用可能な、高品質な擬似乱数生成エンジンの1つです。
7 * コンストラクタは、乱数生成を開始するためのシード（種）を設定するために使用されます。
8 */
9
10// 1. シードを明示的に指定せずにインスタンスを生成する
11//    引数なしの場合、内部的に安全なランダムなシードが自動的に生成されます。
12//    これにより、通常は実行するたびに異なる乱数列が得られます。
13$engineWithoutSeed = new Random\Engine\Xoshiro256StarStar();
14echo "シードなしで乱数エンジンを生成しました。\n";
15
16// 2. 整数値のシードを指定してインスタンスを生成する
17//    同じ整数シード値を使用すると、再現可能な同じ順序の乱数が生成されます。
18//    これは、テストやデバッグで結果を予測可能にしたい場合に便利です。
19$engineWithIntSeed = new Random\Engine\Xoshiro256StarStar(12345);
20echo "整数シード '12345' で乱数エンジンを生成しました。\n";
21
22// 3. 文字列のシードを指定してインスタンスを生成する
23//    文字列をシードとして指定することも可能です。
24//    内部的にはこの文字列がハッシュ化され、乱数生成のシードとして利用されます。
25$engineWithStringSeed = new Random\Engine\Xoshiro256StarStar("my_secret_random_seed");
26echo "文字列シード 'my_secret_random_seed' で乱数エンジンを生成しました。\n";
27
28// 補足:
29// 生成した Random\Engine\Xoshiro256StarStar のインスタンスは、
30// 通常 Random\Randomizer クラスのコンストラクタに渡して利用します。
31// 例:
32// $randomizer = new Random\Randomizer($engineWithIntSeed);
33// $randomNumber = $randomizer->getInt(1, 100); // 1から100の範囲で乱数を取得
34// echo "生成された乱数 (例): " . $randomNumber . "\n";
35
36?>

このサンプルコードは、PHP 8.2以降で利用可能な高品質な擬似乱数生成エンジンであるRandom\Engine\Xoshiro256StarStarクラスのコンストラクタの使い方を解説しています。コンストラクタは、乱数生成を開始するための「シード（種）」を設定する役割を持ちます。

引数$seedはstring型、int型、またはnullを受け入れます。引数を指定しないかnullを指定した場合、PHPは内部的に安全なランダムなシードを自動的に生成します。これにより、通常は実行するたびに異なる乱数列が得られ、予測不可能な結果が保証されます。整数値のシード（例：12345）を指定すると、同じシード値からは常に同じ順序の乱数が生成されるため、テストやデバッグにおいて結果の再現性を確保したい場合に非常に有効です。また、文字列（例："my_secret_random_seed"）をシードとして指定することも可能で、内部的にはこの文字列がハッシュ化され、乱数生成に利用されます。

このコンストラクタは新しいオブジェクトを生成するメソッドであり、直接的な戻り値はありません。

生成されたRandom\Engine\Xoshiro256StarStarのインスタンスは、通常、Random\Randomizerクラスのコンストラクタに渡して利用します。Random\Randomizerクラスは、指定されたエンジンを用いて、特定の範囲の乱数を取得したり配列をシャッフルしたりするなど、具体的な乱数操作を行うための便利なインターフェースを提供します。このように、コンストラクタでシードを適切に設定することで、様々な乱数生成の要件に対応できます。

Copy
1<?php
2
3// PHP 8 で導入された Random\Engine\Xoshiro256StarStar クラスのコンストラクタ使用例
4
5// Random\Engine\Xoshiro256StarStar クラスのコンストラクタは、
6// 乱数生成の初期状態を決定する「シード」を引数として受け取ります。
7// 引数 `$seed` は `string`, `int`, または `null` の型が指定可能です。
8// デフォルトは `null` で、その場合はPHPが内部的にセキュアなシードを自動生成します。
9
10// ここでは整数値 12345 をシードとして指定し、乱数エンジンを初期化します。
11// 同じシード値を使用すると、毎回同じ乱数列が生成されるため、
12// 動作の再現性が求められるテストなどで有用です。
13$seed = 12345;
14$engine = new Random\Engine\Xoshiro256StarStar($seed);
15
16// 生成した乱数エンジンを Randomizer クラスに渡して利用します。
17// Randomizer クラスは、このエンジンを使って様々な形式の乱数を生成するための
18// 便利なメソッド（例: getInt(), shuffle() など）を提供します。
19$randomizer = new Random\Randomizer($engine);
20
21// シード値 '12345' を使用して、0 から 99 の範囲で乱数を5つ生成し、表示します。
22echo "シード値 '{$seed}' を使用して生成された乱数 (0 から 99):\n";
23for ($i = 0; $i < 5; $i++) {
24    echo "- " . $randomizer->getInt(0, 99) . "\n";
25}
26
27// 注意: コンストラクタでシード値を指定しない場合（例: `new Random\Engine\Xoshiro256StarStar();`）、
28// PHPは実行ごとに異なるセキュアなシードを自動生成するため、毎回異なる乱数列になります。
29
30?>

このサンプルコードは、PHP 8で導入された新しい乱数生成エンジンである Random\Engine\Xoshiro256StarStar クラスのコンストラクタ __construct の使用例を示しています。

このコンストラクタは、乱数生成の初期状態を決定する「シード」を引数として受け取ります。引数 $seed には、string、int、または null の型を指定できます。デフォルトは null であり、その場合はPHPが内部的にセキュアで予測不可能なシードを自動的に生成します。

サンプルコードでは、整数値 12345 をシードとして明示的に指定し、乱数エンジンを初期化しています。このようにシード値を指定すると、同じシード値を使用する限り、毎回同じ乱数列が生成されます。これは、テストなどで動作の再現性が求められる場合に役立ちます。コンストラクタは新しいオブジェクトを初期化するメソッドであるため、直接的な戻り値はありません。

初期化された乱数エンジンは、Random\Randomizer クラスに渡されて利用されます。Randomizer クラスは、このエンジンを用いて様々な形式の乱数を生成するための便利なメソッドを提供します。この例では、指定されたシード値に基づき、0から99の範囲で5つの乱数を生成し表示しています。もしコンストラクタでシード値を指定しない場合、PHPは実行ごとに異なるシードを自動生成するため、生成される乱数列は毎回異なります。