StuRandom::generateRandomValueStandardNormalDistribution() - Code Metrics - Inspection of "standard normal distribution as stuRandom option" - st-universe/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a65ee9...c98373 )

by Nico

created 2023-09-01 10:25 UTC

generateRandomValueStandardNormalDistribution() A

↳ Parent: StuRandom

Complexity

Conditions	3
Paths	2

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	9
nc	2
nop	2
dl	0
loc	14
ccs	9
cts	9
cp	1
crap	3
rs	9.9666
c	0
b	0
f	0

<?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);

    }

    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);
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
    }
}


1		<?php
2
3		namespace Stu\Module\Control;
4
5		/**
6		* This class adds the possibility to inject a random generator
7		*/
8		class StuRandom
9		{
10	1	public function rand(int $min, int $max, bool $useStandardNormalDistribution = false): int
11		{
12	1	if ($useStandardNormalDistribution) {
13	1	return $this->generateRandomValueStandardNormalDistribution($min, $max);
14		}
15
16		return random_int($min, $max);
17		}
18
19		public function array_rand(array $array): string\|int
20		{
21		return array_rand($array);
		0 ignored issues – show Bug Best Practice introduced 2023-04-24 16:02 UTC by Report Bug Copy Issue Report 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. Loading history...
22		}
23
24	1	private function generateRandomValueStandardNormalDistribution(int $min, int $max): int
25		{
26	1	$mean = (int)(($min + $max) / 2); // MW
27	1	$stdDeviation = (int) ($mean / 2.5); // FWHM
28
29		do {
30	1	$value = random_int($min, $max);
31	1	$probability = exp(-0.5 * (($value - $mean) / $stdDeviation) ** 2); // normal distribution
32	1	$randomProbability = random_int(0, mt_getrandmax()) / mt_getrandmax();
33
34	1	if ($randomProbability <= $probability) {
35	1	return $value;
36		}
37	1	} while (true);
		0 ignored issues – show Bug Best Practice introduced 2023-08-31 18:28 UTC by Report Bug Copy Issue Report 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. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
38		}
39		}
40

st-universe / core

Push — master ( a65ee9...c98373 )

generateRandomValueStandardNormalDistribution() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like