Samsara\Fermat\Provider\Distribution\Exponential

Complexity

Total Complexity

14

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	rangeRandom()	0	18	4
A	rangePdf()	0	17	3
A	random()	0	13	1
A	__construct()	0	13	2
A	pdf()	0	20	2
A	cdf()	0	22	2

<?php

namespace Samsara\Fermat\Provider\Distribution;

use RandomLib\Factory;
use Samsara\Exceptions\UsageError\IntegrityConstraint;
use Samsara\Exceptions\UsageError\OptionalExit;
use Samsara\Fermat\Numbers;
use Samsara\Fermat\Provider\Distribution\Base\Distribution;
use Samsara\Fermat\Types\Base\DecimalInterface;
use Samsara\Fermat\Values\ImmutableNumber;

class Exponential extends Distribution
{

    /**
     * @var ImmutableNumber
     */
    private $lambda;

    /**
     * Exponential constructor.
     *
     * @param int|float|DecimalInterface $lambda This is the *rate parameter* not the *scale parameter*
     *
     * @throws IntegrityConstraint
     */
    public function __construct($lambda)
    {
        $lambda = Numbers::makeOrDont(Numbers::IMMUTABLE, $lambda);

        if (!$lambda->isPositive()) {
            throw new IntegrityConstraint(
                'Lambda must be positive',
                'Provide a positive lambda',
                'Exponential distributions work on time to occurrence; the mean time to occurrence (lambda) must be positive'
            );
        }

        $this->lambda = $lambda;

It seems like $lambda can also be of type Samsara\Fermat\Values\MutableNumber. However, the property $lambda is declared as type Samsara\Fermat\Values\ImmutableNumber. Maybe add an additional type check?

    }

    /**
     * @param int|float|DecimalInterface $x
     *
     * @return ImmutableNumber
     * @throws IntegrityConstraint
     */
    public function cdf($x): ImmutableNumber
    {

        $x = Numbers::makeOrDont(Numbers::IMMUTABLE, $x);
        /** @var ImmutableNumber $one */
        $one = Numbers::makeOne();

        if (!$x->isPositive()) {
            throw new IntegrityConstraint(
                'X must be positive',
                'Provide a positive x',
                'Exponential distributions work on time to occurrence; the time to occurrence (x) must be positive'
            );
        }

        /** @var ImmutableNumber $e */
        $e = Numbers::makeE();

        /** @var ImmutableNumber $cdf */
        $cdf = $one->subtract($e->pow($x->multiply($this->lambda)->multiply(-1)));

The method multiply() does not exist on Samsara\Fermat\Types\Base\DecimalInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Samsara\Fermat\Types\Base\DecimalInterface.

The method multiply() does not exist on Samsara\Fermat\Types\Base\FractionInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Samsara\Fermat\Types\Base\FractionInterface.

        return $cdf;

    }

    /**
     * @param $x
     *
     * @return ImmutableNumber
     * @throws IntegrityConstraint
     */
    public function pdf($x): ImmutableNumber
    {

        $x = Numbers::makeOrDont(Numbers::IMMUTABLE, $x);

        if (!$x->isPositive()) {
            throw new IntegrityConstraint(
                'X must be positive',
                'Provide a positive x',
                'Exponential distributions work on time to occurrence; the time to occurrence (x) must be positive'
            );
        }

        /** @var ImmutableNumber $e */
        $e = Numbers::makeE();

        /** @var ImmutableNumber $pdf */
        $pdf = $this->lambda->multiply($e->pow($this->lambda->multiply(-1)->multiply($x)));

        return $pdf;

    }

    /**
     * @param $x1
     * @param $x2
     *
     * @return ImmutableNumber
     * @throws IntegrityConstraint
     */
    public function rangePdf($x1, $x2): ImmutableNumber
    {
        $x1 = Numbers::makeOrDont(Numbers::IMMUTABLE, $x1);
        $x2 = Numbers::makeOrDont(Numbers::IMMUTABLE, $x2);

        if (!$x1->isPositive() || !$x2->isPositive()) {
            throw new IntegrityConstraint(
                'X must be positive',
                'Provide a positive x',
                'Exponential distributions work on time to occurrence; the time to occurrence (x) must be positive'
            );
        }

        /** @var ImmutableNumber $rangePdf */
        $rangePdf = $this->pdf($x2)->subtract($this->pdf($x1))->abs();

        return $rangePdf;
    }

    /**
     * @return ImmutableNumber
     */
    public function random(): ImmutableNumber
    {

        $randFactory = new Factory();
        $generator = $randFactory->getMediumStrengthGenerator();
        $one = Numbers::makeOne();
        $u = Numbers::make(Numbers::IMMUTABLE, $generator->generateInt(), 20);
        $u = $u->divide(PHP_INT_MAX);

The method divide() does not exist on Samsara\Fermat\Types\Base\FractionInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Samsara\Fermat\Types\Base\FractionInterface.

        /** @var ImmutableNumber $random */
        $random = $one->subtract($u)->ln()->divide($this->lambda->multiply(-1));

The method divide() does not exist on Samsara\Fermat\Types\Base\DecimalInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Samsara\Fermat\Types\Base\DecimalInterface.

        return $random;

    }

    /**
     * @param int|float|DecimalInterface $min
     * @param int|float|DecimalInterface $max
     * @param int $maxIterations
     *
     * @return ImmutableNumber
     * @throws OptionalExit
     */
    public function rangeRandom($min = 0, $max = PHP_INT_MAX, int $maxIterations = 20): ImmutableNumber
    {

        $i = 0;

        do {
            $randomNumber = $this->random();
            $i++;
        } while (($randomNumber->isGreaterThan($max) || $randomNumber->isLessThan($min)) && $i < $maxIterations);

        if ($randomNumber->isGreaterThan($max) || $randomNumber->isLessThan($min)) {
            throw new OptionalExit(
                'All random numbers generated were outside of the requested range',
                'A suitable random number, restricted by the $max ('.$max.') and $min ('.$min.'), could not be found within '.$maxIterations.' iterations'

Are you sure $min of type integer|double|Samsara\Fermat\Types\Base\DecimalInterface can be used in concatenation?

Are you sure $max of type integer|double|Samsara\Fermat\Types\Base\DecimalInterface can be used in concatenation?

            );
        }

        return $randomNumber;
    }

}