【PHP8.x】mt_rand()関数の使い方

Copy
1<?php
2
3/**
4 * mt_rand() を使用して乱数を生成する例
5 * PHP 7.1 より前のバージョンでは、min > max の場合にバグが存在した。
6 * この例では、min と max の値を検証し、安全に乱数を生成する。
7 */
8function generateSafeRandomNumber(int $min, int $max): int
9{
10    // min が max より大きい場合のチェック
11    if ($min > $max) {
12        // 引数を入れ替えるか、エラーをスローするなどの適切な処理を行う
13        throw new InvalidArgumentException("min must be less than or equal to max");
14    }
15
16    // mt_rand() を使用して乱数を生成
17    return mt_rand($min, $max);
18}
19
20// 使用例
21try {
22    $randomNumber = generateSafeRandomNumber(1, 100);
23    echo "生成された乱数: " . $randomNumber . PHP_EOL;
24
25    // バグが発生する可能性のあるケース (PHP 7.1 未満) をテスト
26    // generateSafeRandomNumber(100, 1); // これは例外をスローする
27} catch (InvalidArgumentException $e) {
28    echo "エラー: " . $e->getMessage() . PHP_EOL;
29}

PHPのmt_rand()関数は、メルセンヌ・ツイスター法に基づいた乱数を生成する関数です。引数 $min と $max で乱数の範囲を指定します。どちらの引数も省略可能で、省略した場合はプラットフォームに依存した範囲で乱数が生成されます。戻り値は、$min と $max の間の整数値です。

このサンプルコードでは、mt_rand()関数を安全に使用するためのgenerateSafeRandomNumber()関数を定義しています。PHP 7.1より前のバージョンでは、$min が $max より大きい場合にmt_rand()が正しく動作しないバグがありました。そのため、generateSafeRandomNumber()関数内では、まず $min が $max より大きくないかを確認し、大きい場合は InvalidArgumentException をスローして、バグを回避しています。これにより、mt_rand()関数を安全に利用できます。

サンプルコードでは、try-catch ブロックを使用して、例外処理を行っています。generateSafeRandomNumber()関数を呼び出す際に、$min が $max より大きい値を渡すと、InvalidArgumentException が発生し、catch ブロックでエラーメッセージが表示されます。正常に乱数が生成された場合は、生成された乱数が表示されます。この例を通じて、mt_rand()関数の使用方法と、潜在的なバグに対する安全なコーディングについて学ぶことができます。

Copy
1<?php
2
3/**
4 * mt_rand 関数を使用して、指定範囲の乱数を生成するサンプルコード。
5 * mt_rand は rand 関数よりも高速で、より高品質な乱数を生成します。
6 * 偏りを考慮し、適切な範囲を指定することが重要です。
7 */
8
9// 最小値と最大値を指定して乱数を生成
10$min = 1;
11$max = 100;
12$random_number = mt_rand($min, $max);
13
14echo "生成された乱数: " . $random_number . PHP_EOL;
15
16// 最小値と最大値を省略した場合、PHP_INT_MIN から PHP_INT_MAX までの乱数を生成
17$random_number_full_range = mt_rand();
18echo "フルレンジで生成された乱数: " . $random_number_full_range . PHP_EOL;
19
20// 乱数の偏りを確認するための簡単なテスト
21function test_mt_rand_bias(int $min, int $max, int $iterations = 10000): void {
22    $counts = [];
23    for ($i = 0; $i < $iterations; $i++) {
24        $rand = mt_rand($min, $max);
25        if (!isset($counts[$rand])) {
26            $counts[$rand] = 0;
27        }
28        $counts[$rand]++;
29    }
30
31    ksort($counts); // 結果をソート
32
33    echo "偏りテスト (範囲: {$min} - {$max}, 試行回数: {$iterations}):" . PHP_EOL;
34    foreach ($counts as $number => $count) {
35        $percentage = round(($count / $iterations) * 100, 2);
36        echo "{$number}: {$count}回 ({$percentage}%)" . PHP_EOL;
37    }
38}
39
40// 偏りテストの実行例
41test_mt_rand_bias(1, 5);

PHPのmt_rand関数は、より高品質な乱数を生成するための関数です。rand関数よりも高速であるという特徴があります。mt_rand($min, $max)のように、最小値$minと最大値$maxを引数に指定することで、その範囲内の乱数を整数値（int型）として返します。引数を省略した場合、PHP_INT_MINからPHP_INT_MAXまでの範囲で乱数を生成します。

サンプルコードでは、mt_randを使用して1から100までの乱数を生成し、その結果を表示しています。また、引数を省略した場合の動作も確認できます。

さらに、乱数の偏りを確認するためのtest_mt_rand_bias関数を定義し、簡単なテストを実施しています。この関数は、指定された範囲で乱数を生成し、各数値が出現する回数をカウントすることで、偏りの有無を視覚的に確認できます。mt_randを使用する際には、生成される乱数が偏っていないか、適切な範囲で利用されているかを確認することが重要です。特に、セキュリティに関わる用途で使用する場合は注意が必要です。

Copy
1<?php
2
3/**
4 * 指定された桁数のランダムな整数を生成します。
5 *
6 * @param int $digits 生成したい整数の桁数。1以上の整数を指定してください。
7 * @return int 指定された桁数のランダムな整数。
8 * @throws InvalidArgumentException $digits が1未満の場合にスローされます。
9 */
10function generateRandomNumberByDigits(int $digits): int
11{
12    if ($digits < 1) {
13        throw new InvalidArgumentException("桁数は1以上である必要があります。");
14    }
15
16    // 指定された桁数の最小値と最大値を計算します。
17    // 例: 4桁の場合、最小値は1000 (10^(4-1))、最大値は9999 (10^4 - 1)
18    $min = (int)pow(10, $digits - 1);
19    $max = (int)pow(10, $digits) - 1;
20
21    // mt_rand関数を使用して、指定された範囲で高速な擬似乱数を生成します。
22    return mt_rand($min, $max);
23}
24
25// --- 使用例 ---
26
27// 4桁のランダムな整数を生成し、出力します。
28$randomNumber4Digits = generateRandomNumberByDigits(4);
29echo "4桁の乱数: " . $randomNumber4Digits . PHP_EOL;
30
31// 6桁のランダムな整数を生成し、出力します。
32$randomNumber6Digits = generateRandomNumberByDigits(6);
33echo "6桁の乱数: " . $randomNumber6Digits . PHP_EOL;
34
35// 1桁のランダムな整数を生成し、出力します。
36$randomNumber1Digit = generateRandomNumberByDigits(1);
37echo "1桁の乱数: " . $randomNumber1Digit . PHP_EOL;
38
39// 注意: 引数に無効な値（例: 0や負の数）を渡すとInvalidArgumentExceptionが発生します。
40// 例: generateRandomNumberByDigits(0); // これを実行するとエラーが発生します。

PHP 8のmt_rand関数は、メルセンヌ・ツイスターアルゴリズムに基づいた高速な擬似乱数を生成する関数です。このサンプルコードでは、mt_rand関数を効果的に利用し、指定された桁数のランダムな整数を生成するgenerateRandomNumberByDigitsというカスタム関数を定義しています。

generateRandomNumberByDigits関数は、$digitsという整数型の引数を受け取ります。この引数には、生成したい乱数の桁数を1以上の整数で指定します。戻り値は、指定された桁数のランダムな整数です。 この関数は、まず引数$digitsが1未満の場合にInvalidArgumentExceptionをスローし、不正な入力からプログラムの安定性を保ちます。その後、指定された桁数に基づいて乱数の最小値と最大値を計算します。例えば4桁の乱数を求める場合、最小値は1000、最大値は9999となります。最終的に、mt_rand関数を計算した最小値と最大値を引数に指定して呼び出すことで、この範囲内で高速な擬似乱数を生成し、その結果を戻り値として返します。

使用例では、generateRandomNumberByDigits関数を呼び出して、4桁、6桁、1桁のランダムな整数をそれぞれ生成し、その結果を出力しています。これにより、特定の桁数の乱数を簡単に取得できることを示しています。引数に0や負の数を渡すとエラーが発生する点も注意喚起されており、関数の正しい使い方を理解する上で重要です。

Copy
1<?php
2
3/**
4 * 指定された範囲内で浮動小数点数（float）の乱数を生成します。
5 * mt_rand() 関数は整数を生成するため、浮動小数点数を得るには追加の計算が必要です。
6 *
7 * @param float $min 乱数の最小値（包括）。
8 * @param float $max 乱数の最大値（包括）。
9 * @return float 指定された範囲内のランダムな浮動小数点数。
10 * @throws InvalidArgumentException $min が $max より大きい場合にスローされます。
11 */
12function generateRandomFloat(float $min, float $max): float
13{
14    if ($min > $max) {
15        throw new InvalidArgumentException('$min は $max より大きくすることはできません。');
16    }
17
18    // mt_rand() は、メルセンヌツイスターアルゴリズムに基づいた擬似乱数整数を生成します。
19    // 引数なしの場合、0 から mt_getrandmax() までの整数を返します。
20    $randomInteger = mt_rand();
21
22    // 整数乱数を mt_getrandmax() で割ることで、0.0 から 1.0 の範囲の浮動小数点数に変換します。
23    // mt_getrandmax() を (float) にキャストして、浮動小数点数での除算を確実にします。
24    $randomZeroToOne = $randomInteger / (float)mt_getrandmax();
25
26    // 0.0 から 1.0 の範囲の値を、目的の範囲 [$min, $max] にスケーリングして返します。
27    return $min + $randomZeroToOne * ($max - $min);
28}
29
30// --- サンプルコードの実行例 ---
31
32// 1.0から10.0の範囲でランダムな浮動小数点数を生成し、表示します。
33echo "1.0から10.0のランダムな浮動小数点数: " . generateRandomFloat(1.0, 10.0) . PHP_EOL;
34
35// -5.5から5.5の範囲でランダムな浮動小数点数を生成し、表示します。
36echo "-5.5から5.5のランダムな浮動小数点数: " . generateRandomFloat(-5.5, 5.5) . PHP_EOL;
37
38// 0.0から1.0の範囲でランダムな浮動小数点数を生成し、表示します。
39echo "0.0から1.0のランダムな浮動小数点数: " . generateRandomFloat(0.0, 1.0) . PHP_EOL;
40
41?>

PHPのmt_rand関数は、擬似乱数を生成します。このサンプルコードは、mt_rand関数が「整数」の乱数を生成するのに対し、それを応用して「浮動小数点数（float）」の乱数を生成する方法を示しています。

mt_rand関数は、引数に最小値（$min）と最大値（$max）を整数で指定すると、その範囲内のランダムな整数を返します。引数を省略した場合、0からmt_getrandmax()（mt_rand関数が生成できる最大の整数値）までの整数を返します。この関数の戻り値は常にint型、つまり整数です。

サンプルコードのgenerateRandomFloat関数は、浮動小数点数の乱数が必要な場合に対応するために作られたカスタム関数です。この関数は、引数$minと$maxに浮動小数点数を受け取り、その範囲内の浮動小数点数の乱数を返します。

generateRandomFloat関数の内部では、まずmt_rand()を引数なしで呼び出して、0からmt_getrandmax()までの整数乱数を取得します。次に、この整数を(float)mt_getrandmax()で割ることで、0.0から1.0の間の浮動小数点数に変換しています。最後に、この0.0から1.0の値を、generateRandomFloat関数に指定された$minと$maxの範囲に合わせてスケーリングし、結果として浮動小数点数を返しています。

このように、mt_rand関数は整数を扱いますが、追加の計算を組み合わせることで、浮動小数点数の乱数も柔軟に生成できます。