Phpml\Metric\Regression

Complexity

Total Complexity

13

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	meanSquaredError()	0	10	2
A	r2Score()	0	5	1
A	maxError()	0	10	2
A	meanSquaredLogarithmicError()	0	10	2
A	medianAbsoluteError()	0	10	2
A	assertCountEquals()	0	4	2
A	meanAbsoluteError()	0	10	2

<?php

declare(strict_types=1);

namespace Phpml\Metric;

use Phpml\Exception\InvalidArgumentException;
use Phpml\Math\Statistic\Correlation;
use Phpml\Math\Statistic\Mean;

final class Regression
{
    public static function meanSquaredError(array $targets, array $predictions): float
    {
        self::assertCountEquals($targets, $predictions);

        $errors = [];
        foreach ($targets as $index => $target) {
            $errors[] = (($target - $predictions[$index]) ** 2);
        }

        return Mean::arithmetic($errors);
    }

    public static function meanSquaredLogarithmicError(array $targets, array $predictions): float
    {
        self::assertCountEquals($targets, $predictions);

        $errors = [];
        foreach ($targets as $index => $target) {
            $errors[] = log((1 + $target) / (1 + $predictions[$index])) ** 2;
        }

        return Mean::arithmetic($errors);
    }

    public static function meanAbsoluteError(array $targets, array $predictions): float
    {
        self::assertCountEquals($targets, $predictions);

        $errors = [];
        foreach ($targets as $index => $target) {
            $errors[] = abs($target - $predictions[$index]);
        }

        return Mean::arithmetic($errors);
    }

    public static function medianAbsoluteError(array $targets, array $predictions): float
    {
        self::assertCountEquals($targets, $predictions);

        $errors = [];
        foreach ($targets as $index => $target) {
            $errors[] = abs($target - $predictions[$index]);
        }

        return (float) Mean::median($errors);
    }

    public static function r2Score(array $targets, array $predictions): float
    {
        self::assertCountEquals($targets, $predictions);

        return Correlation::pearson($targets, $predictions) ** 2;
    }

    public static function maxError(array $targets, array $predictions): float
    {
        self::assertCountEquals($targets, $predictions);

        $errors = [];
        foreach ($targets as $index => $target) {
            $errors[] = abs($target - $predictions[$index]);
        }

        return (float) max($errors);
    }

    private static function assertCountEquals(array &$targets, array &$predictions): void
    {
        if (count($targets) !== count($predictions)) {
            throw new InvalidArgumentException('Targets count must be equal with predictions count');
        }
    }
}