WebSVN – lars-tiefland.laravel_shop – Diff – /trunk/vendor/brick/math/src/BigNumber.php

      * - floating point numbers are converted to a string then parsed as such
      * - strings containing a `/` character are returned as BigRational
      * - strings containing a `.` character or using an exponential notation are returned as BigDecimal
      * - strings containing only digits with an optional leading `+` or `-` sign are returned as BigInteger
+     *
-     * @param BigNumber|int|float|string $value
-     *
-     * @return BigNumber
-     *
      * @throws NumberFormatException   If the format of the number is not valid.
      * @throws DivisionByZeroException If the value represents a rational number with a denominator of zero.
+     *
      * @psalm-pure
      */
-    public static function of($value) : BigNumber
+    public static function of(BigNumber|int|float|string $value) : BigNumber
+    {
         if ($value instanceof BigNumber) {
             return $value;
+        }
         if (\is_int($value)) {
             return new BigInteger((string) $value);
-        }
+        }
         /** @psalm-suppress RedundantCastGivenDocblockType We cannot trust the untyped $value here! */
-        $value = \is_float($value) ? self::floatToString($value) : (string) $value;
+        $value = \is_float($value) ? self::floatToString($value) : $value;
         $throw = static function() use ($value) : void {
     /**
      * Safely converts float to string, avoiding locale-dependent issues.
+     *
      * @see https://github.com/brick/math/pull/20
+     *
-     * @param float $float
-     *
-     * @return string
-     *
      * @psalm-pure
      * @psalm-suppress ImpureFunctionCall
      */
     private static function floatToString(float $float) : string
+    {
         return $result;
+    }
     /**
-     * Proxy method to access protected constructors from sibling classes.
+     * Proxy method to access BigInteger's protected constructor from sibling classes.
+     *
+     * @internal
+     * @psalm-pure
+     */
+    protected function newBigInteger(string $value) : BigInteger
+    {
+        return new BigInteger($value);
+    }
     /**
+     * Proxy method to access BigDecimal's protected constructor from sibling classes.
+     *
+     * @internal
-     * @internal
+     * @psalm-pure
-     *
+     */
-     * @param mixed ...$args The arguments to the constructor.
+    protected function newBigDecimal(string $value, int $scale = 0) : BigDecimal
+    {
+        return new BigDecimal($value, $scale);
+    }
     /**
+     * Proxy method to access BigRational's protected constructor from sibling classes.
      * @return static
-     *
-     * @psalm-pure
-     * @psalm-suppress TooManyArguments
+     * @internal
-     * @psalm-suppress UnsafeInstantiation
+     * @psalm-pure
      */
-    protected static function create(... $args) : BigNumber
+    protected function newBigRational(BigInteger $numerator, BigInteger $denominator, bool $checkDenominator) : BigRational
+    {
-        return new static(... $args);
+        return new BigRational($numerator, $denominator, $checkDenominator);
+    }
     /**
      * Returns the minimum of the given values.
+     *
-     * @param BigNumber|int|float|string ...$values The numbers to compare. All the numbers need to be convertible
-     *                                              to an instance of the class this method is called on.
      * @param BigNumber|int|float|string ...$values The numbers to compare. All the numbers need to be convertible
-     * @return static The minimum value.
+     *                                              to an instance of the class this method is called on.
+     *
      * @throws \InvalidArgumentException If no values are given.
      * @throws MathException             If an argument is not valid.
+     *
      * @psalm-suppress LessSpecificReturnStatement
      * @psalm-suppress MoreSpecificReturnType
      * @psalm-pure
      */
-    public static function min(...$values) : BigNumber
+    public static function min(BigNumber|int|float|string ...$values) : static
+    {
      * Returns the maximum of the given values.
+     *
      * @param BigNumber|int|float|string ...$values The numbers to compare. All the numbers need to be convertible
      *                                              to an instance of the class this method is called on.
+     *
-     * @return static The maximum value.
-     *
      * @throws \InvalidArgumentException If no values are given.
      * @throws MathException             If an argument is not valid.
+     *
      * @psalm-suppress LessSpecificReturnStatement
      * @psalm-suppress MoreSpecificReturnType
      * @psalm-pure
      */
-    public static function max(...$values) : BigNumber
+    public static function max(BigNumber|int|float|string ...$values) : static
+    {
         $max = null;
         foreach ($values as $value) {
      * Returns the sum of the given values.
+     *
      * @param BigNumber|int|float|string ...$values The numbers to add. All the numbers need to be convertible
      *                                              to an instance of the class this method is called on.
+     *
-     * @return static The sum.
-     *
      * @throws \InvalidArgumentException If no values are given.
      * @throws MathException             If an argument is not valid.
+     *
-     * @psalm-suppress LessSpecificReturnStatement
-     * @psalm-suppress MoreSpecificReturnType
      * @psalm-pure
      */
-    public static function sum(...$values) : BigNumber
+    public static function sum(BigNumber|int|float|string ...$values) : static
+    {
-        /** @var BigNumber|null $sum */
+        /** @var static|null $sum */
         $sum = null;
         foreach ($values as $value) {
      * @todo This could be better resolved by creating an abstract protected method in BigNumber, and leaving to
      *       concrete classes the responsibility to perform the addition themselves or delegate it to the given number,
      *       depending on their ability to perform the operation. This will also require a version bump because we're
      *       potentially breaking custom BigNumber implementations (if any...)
+     *
-     * @param BigNumber $a
-     * @param BigNumber $b
-     *
-     * @return BigNumber
-     *
      * @psalm-pure
      */
     private static function add(BigNumber $a, BigNumber $b) : BigNumber
+    {
         if ($a instanceof BigRational) {
     /**
      * Removes optional leading zeros and + sign from the given number.
+     *
      * @param string $number The number, validated as a non-empty string of digits with optional leading sign.
+     *
-     * @return string
-     *
      * @psalm-pure
      */
     private static function cleanUp(string $number) : string
+    {
         $firstChar = $number[0];
         return $number;
+    }
     /**
-     * Checks if this number is equal to the given one.
-     *
-     * @param BigNumber|int|float|string $that
-     *
-     * @return bool
+     * Checks if this number is equal to the given one.
      */
-    public function isEqualTo($that) : bool
+    public function isEqualTo(BigNumber|int|float|string $that) : bool
+    {
         return $this->compareTo($that) === 0;
+    }
-    /**
-     * Checks if this number is strictly lower than the given one.
-     *
-     * @param BigNumber|int|float|string $that
     /**
-     * @return bool
+     * Checks if this number is strictly lower than the given one.
      */
-    public function isLessThan($that) : bool
+    public function isLessThan(BigNumber|int|float|string $that) : bool
+    {
         return $this->compareTo($that) < 0;
+    }
-    /**
-     * Checks if this number is lower than or equal to the given one.
-     *
      * @param BigNumber|int|float|string $that
-     *
+    /**
-     * @return bool
+     * Checks if this number is lower than or equal to the given one.
      */
-    public function isLessThanOrEqualTo($that) : bool
+    public function isLessThanOrEqualTo(BigNumber|int|float|string $that) : bool
+    {
         return $this->compareTo($that) <= 0;
-    }
-    /**
-     * Checks if this number is strictly greater than the given one.
+    }
-     * @param BigNumber|int|float|string $that
     /**
-     * @return bool
+     * Checks if this number is strictly greater than the given one.
      */
-    public function isGreaterThan($that) : bool
+    public function isGreaterThan(BigNumber|int|float|string $that) : bool
+    {
-        return $this->compareTo($that) > 0;
-    }
-    /**
-     * Checks if this number is greater than or equal to the given one.
+        return $this->compareTo($that) > 0;
-     *
+    }
      * @param BigNumber|int|float|string $that
     /**
-     * @return bool
+     * Checks if this number is greater than or equal to the given one.
      */
-    public function isGreaterThanOrEqualTo($that) : bool
+    public function isGreaterThanOrEqualTo(BigNumber|int|float|string $that) : bool
-    {
-        return $this->compareTo($that) >= 0;
+    {
         return $this->compareTo($that) >= 0;
     /**
      * Checks if this number equals zero.
     /**
-     * @return bool
+     * Checks if this number equals zero.
      */
-    public function isZero() : bool
-    {
-        return $this->getSign() === 0;
+    public function isZero() : bool
+    {
         return $this->getSign() === 0;
     /**
      * Checks if this number is strictly negative.
     /**
-     * @return bool
+     * Checks if this number is strictly negative.
-     */
-    public function isNegative() : bool
      */
-        return $this->getSign() < 0;
+    public function isNegative() : bool
+    {
         return $this->getSign() < 0;
     /**
      * Checks if this number is negative or zero.
     /**
-     * @return bool
-     */
-    public function isNegativeOrZero() : bool
+     * Checks if this number is negative or zero.
      */
-        return $this->getSign() <= 0;
+    public function isNegativeOrZero() : bool
+    {
         return $this->getSign() <= 0;
     /**
      * Checks if this number is strictly positive.
-     *
-     * @return bool
-     */
+    /**
-    public function isPositive() : bool
+     * Checks if this number is strictly positive.
      */
-        return $this->getSign() > 0;
+    public function isPositive() : bool
+    {
     abstract public function getSign() : int;
     /**
      * Compares this number to the given one.
-     *
-     * @param BigNumber|int|float|string $that
+     *
      * @return int [-1,0,1] If `$this` is lower than, equal to, or greater than `$that`.
+     *
      * @throws MathException If the number is not valid.
      */
-    abstract public function compareTo($that) : int;
+    abstract public function compareTo(BigNumber|int|float|string $that) : int;
     /**
-     * Converts this number to a BigInteger.
-     *
-     * @return BigInteger The converted number.
+     * Converts this number to a BigInteger.
+     *
      * @throws RoundingNecessaryException If this number cannot be converted to a BigInteger without rounding.
      */
     abstract public function toBigInteger() : BigInteger;
-    /**
-     * Converts this number to a BigDecimal.
     /**
-     * @return BigDecimal The converted number.
+     * Converts this number to a BigDecimal.
+     *
      * @throws RoundingNecessaryException If this number cannot be converted to a BigDecimal without rounding.
      */
-    abstract public function toBigDecimal() : BigDecimal;
-    /**
+    abstract public function toBigDecimal() : BigDecimal;
      * Converts this number to a BigRational.
     /**
-     * @return BigRational The converted number.
+     * Converts this number to a BigRational.
      */
     abstract public function toBigRational() : BigRational;
     /**
-     * Converts this number to a BigDecimal with the given scale, using rounding if necessary.
-     *
-     * @param int $scale        The scale of the resulting `BigDecimal`.
+     * Converts this number to a BigDecimal with the given scale, using rounding if necessary.
      * @param int $roundingMode A `RoundingMode` constant.
      * @param int $scale        The scale of the resulting `BigDecimal`.
-     * @return BigDecimal
+     * @param int $roundingMode A `RoundingMode` constant.
      * Returns the exact value of this number as a native integer.
+     *
      * If this number cannot be converted to a native integer without losing precision, an exception is thrown.
      * Note that the acceptable range for an integer depends on the platform and differs for 32-bit and 64-bit.
+     *
-     * @return int The converted value.
-     *
      * @throws MathException If this number cannot be exactly converted to a native integer.
      */
     abstract public function toInt() : int;
      * Note that this method can discard information as the precision of a floating-point value
      * is inherently limited.
+     *
      * If the number is greater than the largest representable floating point number, positive infinity is returned.
      * If the number is less than the smallest representable floating point number, negative infinity is returned.
-     *
-     * @return float The converted value.
      */
     abstract public function toFloat() : float;
     /**
      * Returns a string representation of this number.
+     *
      * The output of this method can be parsed by the `of()` factory method;
-     * this will yield an object equal to this one, without any information loss.
-     *
-     * @return string
+     * this will yield an object equal to this one, without any information loss.
      */
-    abstract public function __toString() : string;
-    /**
-     * {@inheritdoc}
+    abstract public function __toString() : string;
      */
     public function jsonSerialize() : string
+    {
         return $this->__toString();

Subversion-Projekte lars-tiefland.laravel_shop

(root)/trunk/vendor/brick/math/src/BigNumber.php – Revision 148 → 399