StuRandom::generateRandomValueAsymmetricDistribution() - Code Metrics - Inspection of "introduce ion storms" - st-universe/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#2013)

by Nico

created 2025-01-21 19:24 UTC

generateRandomValueAsymmetricDistribution() A

↳ Parent: StuRandom

Complexity

Conditions	4
Paths	4

Size

Total Lines	20
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
cc	4
eloc	12
nc	4
nop	4
dl	0
loc	20
ccs	0
cts	12
cp	0
crap	20
rs	9.8666
c	0
b	0
f	0

<?php

namespace Stu\Module\Control;

use RuntimeException;

/**
 * This class adds the possibility to inject a random generator
 */
class StuRandom
{
    public function rand(
        int $min,
        int $max,
        bool $useStandardNormalDistribution = false,
        ?int $mean = null,
        float $skewness = 0
    ): int {
        if ($skewness != 0 && $useStandardNormalDistribution) {
            return $this->generateRandomValueAsymmetricDistribution($min, $max, $mean, $skewness);
        }

        if ($useStandardNormalDistribution) {
            return $this->generateRandomValueStandardNormalDistribution($min, $max, $mean);
        }


        return random_int($min, $max);
    }

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

    }

    /** @param array<int, int> $probabilities */
    public function randomKeyOfProbabilities(array $probabilities): int
    {
        $totalProbability = array_sum($probabilities);

        $randomNumber = random_int(1, $totalProbability);
        $randomNumber = random_int(1, /** @scrutinizer ignore-type */ $totalProbability);
        $cumulativeProbability = 0;

        foreach ($probabilities as $key => $prob) {
            $cumulativeProbability += $prob;
            if ($randomNumber <= $cumulativeProbability) {
                return $key;
            }
        }

        throw new RuntimeException('this should not happen');
    }

    public function uniqid(): string
    {
        return uniqid();
    }

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

        do {
            $value = random_int($min, $max);
            $probability = exp(-0.5 * (($value - $usedMean) / $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
    }
}
    }

    private function generateRandomValueAsymmetricDistribution(int $min, int $max, ?int $mean = null, float $skewness = 0): int
    {
        $usedMean = $mean ?? ($min + $max) / 2;
        $stdDeviation = ($max - $min) / 6;

        do {
            $value = random_int($min, $max);
            $probability = exp(-0.5 * (($value - $usedMean) / $stdDeviation) ** 2);

            if ($skewness) {
                $skewFactor = 1 + $skewness * (($value - $usedMean) / ($max - $min));
                $probability *= max(0, $skewFactor);
            }

            $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
    }
}
    }
}

st-universe / core

Pull Request — master (#2013)

generateRandomValueAsymmetricDistribution() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like