Stu\Module\Control\StuRandom

Complexity

Total Complexity

6

Size/Duplication

Total Lines	30
Duplicated Lines	0 %

Test Coverage

Coverage

80%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	array_rand()	0	3	1
A	generateRandomValueStandardNormalDistribution()	0	14	3
A	rand()	0	7	2

<?php

namespace Stu\Module\Control;

/**
 * This class adds the possibility to inject a random generator
 */
class StuRandom
{
    public function rand(int $min, int $max, bool $useStandardNormalDistribution = false): int
    {
        if ($useStandardNormalDistribution) {
            return $this->generateRandomValueStandardNormalDistribution($min, $max);
        }

        return random_int($min, $max);
    }

    public function array_rand(array $array): string|int
    {
        return array_rand($array);

The expression return array_rand($array) could return the type array which is incompatible with the type-hinted return integer|string. Consider adding an additional type-check to rule them out.

    }

    private function generateRandomValueStandardNormalDistribution(int $min, int $max): int
    {
        $mean = (int)(($min + $max) / 2); // MW
        $stdDeviation = (int) ($mean / 2.5); // FWHM

        do {
            $value = random_int($min, $max);
            $probability = exp(-0.5 * (($value - $mean) / $stdDeviation) ** 2); // normal distribution
            $randomProbability = random_int(0, mt_getrandmax()) / mt_getrandmax();

            if ($randomProbability <= $probability) {
                return $value;
            }
        } while (true);

In this branch, the function will implicitly return null which is incompatible with the type-hinted return integer. Consider adding a return statement or allowing null as return value.

    }
}