Code-Mine-Development / valueobjects

src/Number/Real.php

<?php

namespace ValueObjects\Number;

use ValueObjects\Exception\InvalidNativeArgumentException;
use ValueObjects\StringLiteral\StringLiteral;
use ValueObjects\Util\Util;
use ValueObjects\ValueObjectInterface;

class Real implements NumberInterface, MathAwareInterface
{
    protected $value;

    /**
     * Returns a Real object given a PHP native float as parameter.
     *
     * @param  float $number

There is no parameter named $number. Was it maybe removed?

     *
     * @return static
     */
    public static function fromNative()
    {
        $value = func_get_arg(0);

        return new static($value);
    }

    /**
     * Returns a Real object given a PHP native float as parameter.
     *
     * @param float $number

There is no parameter named $number. Was it maybe removed?

     */
    public function __construct($value)
    {
        $value = \filter_var($value, FILTER_VALIDATE_FLOAT);

        if (FALSE === $value) {
            throw new InvalidNativeArgumentException($value, ['float']);
        }

        $this->value = $value;
    }

    /**
     * Returns the native value of the real number
     *
     * @return float
     */
    public function toNative()
    {
        return $this->value;
    }

    /**
     * Tells whether two Real are equal by comparing their values
     *
     * @param  ValueObjectInterface $real
     *
     * @return bool
     */
    public function sameValueAs(ValueObjectInterface $real)
    {
        if (FALSE === Util::classEquals($this, $real)) {
            return FALSE;
        }

        return $this->toNative() === $real->toNative();

It seems like you code against a concrete implementation and not the interface ValueObjects\ValueObjectInterface as the method toNative() does only exist in the following implementations of said interface: ValueObjects\Climate\Celsius, ValueObjects\Climate\Fahrenheit, ValueObjects\Climate\Kelvin, ValueObjects\Climate\RelativeHumidity, ValueObjects\Climate\Temperature, ValueObjects\DateTime\Hour, ValueObjects\DateTime\Minute, ValueObjects\DateTime\Month, ValueObjects\DateTime\MonthDay, ValueObjects\DateTime\Second, ValueObjects\DateTime\WeekDay, ValueObjects\DateTime\Year, ValueObjects\Enum\Enum, ValueObjects\Geography\Continent, ValueObjects\Geography\CountryCode, ValueObjects\Geography\DistanceFormula, ValueObjects\Geography\DistanceUnit, ValueObjects\Geography\Ellipsoid, ValueObjects\Geography\Latitude, ValueObjects\Geography\Longitude, ValueObjects\Identity\UUID, ValueObjects\Money\CurrencyCode, ValueObjects\Number\Complex, ValueObjects\Number\Integer, ValueObjects\Number\Natural, ValueObjects\Number\Real, ValueObjects\Number\RoundingMode, ValueObjects\Person\Age, ValueObjects\Person\Gender, ValueObjects\StringLiteral\StringLiteral, ValueObjects\Web\Domain, ValueObjects\Web\EmailAddress, ValueObjects\Web\FragmentIdentifier, ValueObjects\Web\Hostname, ValueObjects\Web\IPAddress, ValueObjects\Web\IPAddressVersion, ValueObjects\Web\IPv4Address, ValueObjects\Web\IPv6Address, ValueObjects\Web\NullFragmentIdentifier, ValueObjects\Web\NullQueryString, ValueObjects\Web\Path, ValueObjects\Web\PortNumber, ValueObjects\Web\QueryString, ValueObjects\Web\SchemeName.

    }

    /**
     * Returns the integer part of the Real number as a Integer
     *
     * @param  RoundingMode $rounding_mode Rounding mode of the conversion. Defaults to RoundingMode::HALF_UP.
     *
     * @return Integer
     */
    public function toInteger(RoundingMode $rounding_mode = NULL)
    {
        if (NULL === $rounding_mode) {
            $rounding_mode = RoundingMode::HALF_UP();
        }

        $value = $this->toNative();
        $integerValue = \round($value, 0, $rounding_mode->toNative());
        $integer = new Integer($integerValue);

        return $integer;
    }

    /**
     * Returns the absolute integer part of the Real number as a Natural
     *
     * @param  RoundingMode $rounding_mode Rounding mode of the conversion. Defaults to RoundingMode::HALF_UP.
     *
     * @return Natural
     */
    public function toNatural(RoundingMode $rounding_mode = NULL)
    {
        $integerValue = $this->toInteger($rounding_mode)->toNative();
        $naturalValue = \abs($integerValue);
        $natural = new Natural($naturalValue);

        return $natural;
    }

    /**
     * Returns the string representation of the real value
     *
     * @return string
     */
    public function __toString()
    {
        return \strval($this->toNative());
    }

    static public function pi()
    {
        return self::fromNative(M_PI);
    }

    /**
     * @param \ValueObjects\Number\MathAwareInterface $number
     *
     * @return MathAwareInterface
     */
    public function add(MathAwareInterface $number)
    {
        return new static((float) bcadd($this, $number, 5));
    }

    /**
     * @param \ValueObjects\Number\MathAwareInterface $number
     *
     * @return MathAwareInterface
     */
    public function subtract(MathAwareInterface $number)
    {
        return new static((float) bcsub($this, $number, 5));

    }

    /**
     * @param \ValueObjects\Number\MathAwareInterface $number
     *
     * @return MathAwareInterface
     */
    public function multiply(MathAwareInterface $number)
    {
        return new static((float) bcmul($this, $number, 5));

    }

    /**
     * @param \ValueObjects\Number\MathAwareInterface $number
     *
     * @return MathAwareInterface
     */
    public function divide(MathAwareInterface $number)
    {
        return new static((float) bcdiv($this, $number, 5));


    }

    /**
     * @param \ValueObjects\Number\MathAwareInterface $number
     *
     * @return MathAwareInterface
     */
    public function toPower(MathAwareInterface $number)
    {
        return new static((float) bcpow($this->toNative(), $number->toNative(), 5));

    }

    /**
     * @return MathAwareInterface
     */
    public function square()
    {
        return new static((float) bcpow($this->toNative(), 2, 5));
    }

    /**
     * @return MathAwareInterface
     */
    public function squareRoot()
    {
        return new static((float) bcsqrt($this, 5));
    }


    /**
     * @return MathAwareInterface
     */
    public function cube()
    {
        return new static((float) bcpow($this->toNative(), 3, 5));

    }

    /**
     * @return bool
     */
    public function isEven()
    {
        return "0" === bcmod($this, 2);
    }

    /**
     * @return bool
     */
    public function isOdd()
    {
        return (FALSE === $this->isEven());
    }

    /**
     * @return MathAwareInterface
     */
    public function factorial()
    {

        $number = $this->toNative();
        $factorial = 1;
        for ($index = 1; $index <= $number; $index++)
            $factorial = bcmul($factorial, $index);

        return new static($factorial);

    }

    /**
     * @param \ValueObjects\Number\MathAwareInterface $number
     *
     * @return bool
     */
    public function isGreaterThan(MathAwareInterface $number)
    {
        return 1 == bccomp($this, $number);
    }

    /**
     * @param \ValueObjects\Number\MathAwareInterface $number
     *
     * @return bool
     */
    public function isGreaterOrEqual(MathAwareInterface $number)
    {
        return 0 <= bccomp($this, $number);

    }

    /**
     * @param \ValueObjects\Number\MathAwareInterface $number
     *
     * @return bool
     */
    public function isLessThan(MathAwareInterface $number)
    {
        return -1 == bccomp($this, $number);

    }

    /**
     * @param \ValueObjects\Number\MathAwareInterface $number
     *
     * @return bool
     */
    public function isLessOrEqual(MathAwareInterface $number)
    {
        return 0 >= bccomp($this, $number);

    }

    /**
     * @param \ValueObjects\Number\MathAwareInterface $number
     *
     * @return MathAwareInterface
     */
    public function modulo(MathAwareInterface $number)
    {
        return new static((float) bcmod($this, $number));
    }

    /**
     * @return bool
     */
    public function isZero()
    {
        return 0 === bccomp($this, "0");
    }

    /**
     * @return bool
     */
    public function isPositive()
    {
        return 1 === bccomp($this, "0");

    }

    /**
     * @return bool
     */
    public function isNegative()
    {
        return -1 === bccomp($this, "0");
    }

    /**
     * @return MathAwareInterface
     */
    public function digits()
    {
        return new static(strlen($this));
    }

    /**
     * @return MathAwareInterface
     */
    public function inverse()
    {
        return $this->multiply(new Real(-1));

    }

    public function increment()
    {
        return $this->add(new Real(1));
    }

    public function decrement()
    {
        return $this->subtract(new Real(1));

    }

    public function by10()
    {
        return $this->divide(new Real(10));

    }

    public function by100()
    {
        return $this->divide(new Real(100));

    }

    /**
     * @return StringLiteral
     */
    public function scientific()
    {
        return new StringLiteral(sprintf('%e', $this->toNative()));
    }

    public static function zero()
    {
        return new static(0);
    }

    public static function random($min = NULL, $max = NULL)
    {
        return new static(mt_rand($min, $max));
    }

    public function absolute()
    {
        if($this->isNegative()) {
            return $this->inverse();
        }

        return $this;
    }



    /**
     * @return float
     */
    function jsonSerialize()

It is generally recommended to explicitly declare the visibility for methods.

It is recommend to declare an explicit visibility for jsonSerialize.

    {
        return $this->toNative();
    }


}