Doctrine\Annotations\Type\Constant\ConstantFloatType

Complexity

Total Complexity

5

Size/Duplication

Total Lines	30
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getValue()	0	3	1
A	__construct()	0	3	1
A	describe()	0	3	1
A	validate()	0	4	2

<?php

declare(strict_types=1);

namespace Doctrine\Annotations\Type\Constant;

use Doctrine\Annotations\Type\ConstantScalarType;
use Doctrine\Annotations\Type\FloatType;
use function abs;
use function is_float;
use function sprintf;

/**
 * @internal
 */
final class ConstantFloatType extends FloatType implements ConstantScalarType
{
    /** Maximum tolerance boundary for float value accuracy. */
    private const EPSILON = 1e-15;

    /** @var float */
    private $value;

    public function __construct(float $value)
    {
        $this->value = $value;
    }

    public function getValue() : float
    {
        return $this->value;
    }

    public function describe() : string
    {
        return sprintf('%F', $this->value);
    }

    /**
     * @param mixed $value
     */
    public function validate($value) : bool
    {
        // Due to IEEE 754 float representation, comparisons are inaccurate so we need some level of tolerance.
        return is_float($value) && abs($value - $this->value) < self::EPSILON;
    }
}