PolynomialFunction::integralExpression() - Code Metrics - Inspection of "F functions" - JordanRL/Fermat - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — dev (#40)

by Jordan

created 2019-03-31 05:54 UTC

PolynomialFunction::integralExpression() A

↳ Parent: PolynomialFunction

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	0

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	0
nc	1
nop	0
dl	0
loc	2
ccs	0
cts	1
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php

namespace Samsara\Fermat\Values\Algebra;

use Samsara\Exceptions\UsageError\IntegrityConstraint;
use Samsara\Fermat\Numbers;
use Samsara\Fermat\Types\Base\DecimalInterface;
use Samsara\Fermat\Types\Base\ExpressionInterface;
use Samsara\Fermat\Types\Base\FunctionInterface;
use Samsara\Fermat\Types\Base\NumberInterface;
use Samsara\Fermat\Types\Expression;
use Samsara\Fermat\Values\ImmutableNumber;

class PolynomialFunction extends Expression implements ExpressionInterface, FunctionInterface
{
    /** @var array  */
    protected $coefficients = [];

    public function __construct(array $coefficients)
    {
        parent::__construct(Expression::POLYNOMIAL);

        foreach ($coefficients as $exponent => $coefficient) {
            if (!is_int($exponent)) {
                throw new IntegrityConstraint(
                    'Keys in the $coefficients array must be integers',
                    'Only use integer keys for the $coefficients array',
                    'The key '.$exponent.' was found in the $coefficients array; an integer was expected'
                );
            }

            if (
                !is_int($coefficient) &&
                !is_float($coefficient) &&
                !is_numeric($coefficient) &&
                !($coefficient instanceof DecimalInterface) &&
                !($coefficient instanceof NumberInterface)
            ) {
                throw new IntegrityConstraint(
                    'Values for coefficients must be valid for an ImmutableNumber constructor',
                    'Only give values which can be used for an ImmutableNumber constructor',
                    'The coefficient '.$coefficient.' is not valid for an ImmutableNumber constructor'
                );
            }
        }

        $this->coefficients = $coefficients;

        $this->expression = function($x) use ($coefficients): ImmutableNumber {
            /** @var ImmutableNumber $value */
            $value = Numbers::makeZero();

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

            foreach ($coefficients as $exponent => $coefficient) {
                /** @var ImmutableNumber $term */
                $term = Numbers::makeOrDont(Numbers::IMMUTABLE, $coefficient);

                if ($term->isEqual(0)) {
                    continue;
                }

                if ($exponent == 0) {
                    $value = $value->add($term);
                } else {
                    $term = $term->multiply($xPart->pow($exponent));
                    $value = $value->add($term);
                }
            }

            return $value;
        };
    }

    public function evaluateAt($x): NumberInterface
    {
        $answer = $this->expression;

        return $answer($x);
    }

    public function derivativeExpression(): ExpressionInterface
    {
        // TODO: Implement derivativeExpression() method.
    }
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

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

    public function integralExpression(): ExpressionInterface
    {
        // TODO: Implement integralExpression() method.
    }
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 Samsara\Fermat\Values\Algebra;
4
5		use Samsara\Exceptions\UsageError\IntegrityConstraint;
6		use Samsara\Fermat\Numbers;
7		use Samsara\Fermat\Types\Base\DecimalInterface;
8		use Samsara\Fermat\Types\Base\ExpressionInterface;
9		use Samsara\Fermat\Types\Base\FunctionInterface;
10		use Samsara\Fermat\Types\Base\NumberInterface;
11		use Samsara\Fermat\Types\Expression;
12		use Samsara\Fermat\Values\ImmutableNumber;
13
14		class PolynomialFunction extends Expression implements ExpressionInterface, FunctionInterface
15		{
16		/** @var array */
17		protected $coefficients = [];
18
19	1	public function __construct(array $coefficients)
20		{
21	1	parent::__construct(Expression::POLYNOMIAL);
22
23	1	foreach ($coefficients as $exponent => $coefficient) {
24	1	if (!is_int($exponent)) {
25		throw new IntegrityConstraint(
26		'Keys in the $coefficients array must be integers',
27		'Only use integer keys for the $coefficients array',
28		'The key '.$exponent.' was found in the $coefficients array; an integer was expected'
29		);
30		}
31
32		if (
33	1	!is_int($coefficient) &&
34	1	!is_float($coefficient) &&
35	1	!is_numeric($coefficient) &&
36	1	!($coefficient instanceof DecimalInterface) &&
37	1	!($coefficient instanceof NumberInterface)
38		) {
39		throw new IntegrityConstraint(
40		'Values for coefficients must be valid for an ImmutableNumber constructor',
41		'Only give values which can be used for an ImmutableNumber constructor',
42		'The coefficient '.$coefficient.' is not valid for an ImmutableNumber constructor'
43		);
44		}
45		}
46
47	1	$this->coefficients = $coefficients;
48
49		$this->expression = function($x) use ($coefficients): ImmutableNumber {
50		/** @var ImmutableNumber $value */
51	1	$value = Numbers::makeZero();
52
53		/** @var ImmutableNumber $xPart */
54	1	$xPart = Numbers::makeOrDont(Numbers::IMMUTABLE, $x);
55
56	1	foreach ($coefficients as $exponent => $coefficient) {
57		/** @var ImmutableNumber $term */
58	1	$term = Numbers::makeOrDont(Numbers::IMMUTABLE, $coefficient);
59
60	1	if ($term->isEqual(0)) {
61	1	continue;
62		}
63
64	1	if ($exponent == 0) {
65	1	$value = $value->add($term);
66		} else {
67	1	$term = $term->multiply($xPart->pow($exponent));
68	1	$value = $value->add($term);
69		}
70		}
71
72	1	return $value;
73		};
74	1	}
75
76	1	public function evaluateAt($x): NumberInterface
77		{
78	1	$answer = $this->expression;
79
80	1	return $answer($x);
81		}
82
83		public function derivativeExpression(): ExpressionInterface
84		{
85		// TODO: Implement derivativeExpression() method.
86		}
		0 ignored issues – show Bug Best Practice introduced 2019-03-31 05:56 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `Samsara\Fermat\Types\Base\ExpressionInterface`. 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...
87
88		public function integralExpression(): ExpressionInterface
89		{
90		// TODO: Implement integralExpression() method.
91		}
		0 ignored issues – show Bug Best Practice introduced 2019-03-31 05:56 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `Samsara\Fermat\Types\Base\ExpressionInterface`. 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...
92
93		}

JordanRL / Fermat

Pull Request — dev (#40)

PolynomialFunction::integralExpression() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like