Ctefan\Kiwi\Strength

Complexity

Total Complexity

6

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Test Coverage

Coverage

75%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	weak()	0	3	1
A	clip()	0	3	1
A	required()	0	3	1
A	strong()	0	3	1
A	medium()	0	3	1
A	create()	0	7	1

<?php
declare(strict_types=1);

namespace Ctefan\Kiwi;

/**
 * Symbolic constraint strengths.
 *
 * Required constraints must be satisfied. Remaining strengths are satisfied with declining priority.
 */
class Strength
{
    /**
     * @return float
     */
    static public function required(): float
    {
        return self::create(1000.0, 1000.0, 1000.0);
    }

    /**
     * @return float
     */
    static public function strong(): float
    {
        return self::create(1.0, 0.0, 0.0);
    }

    /**
     * @return float
     */
    static public function medium(): float
    {
        return self::create(0.0, 1.0, 0.0);
    }

    /**
     * @return float
     */
    static public function weak(): float
    {
        return self::create(0.0, 0.0, 1.0);
    }

    /**
     * Create a new symbolic strength.
     *
     * @param float $a
     * @param float $b
     * @param float $c
     * @param float $w
     * @return float
     */
    static public function create(float $a, float $b, float $c, float $w = 1.0): float
    {
        $strength = 0.0;
        $strength += max(0.0, min(1000.0, $a * $w)) * 1000000.0;
        $strength += max(0.0, min(1000.0, $b * $w)) * 1000.0;
        $strength += max(0.0, min(1000.0, $c * $w));
        return $strength;
    }

    /**
     * Clamp a symbolic strength to the allowed min and max.
     *
     * @param float $strength
     * @return float
     */
    static public function clip(float $strength): float
    {
        return max(0.0, min(self::required(), $strength));
    }
}