GmpCalculator.php

<?php
 
namespace Money\Calculator;
 
use Money\Calculator;
use Money\Money;
use Money\Number;
 
final class GmpCalculator implements Calculator
{
    private $scale;
 
    public function __construct($scale = 14)
    {
        $this->scale = $scale;
    }
 
    public static function supported()
    {
        return extension_loaded('gmp');
    }
 
    public function compare($a, $b)
    {
        $aNum = Number::fromNumber($a);
        $bNum = Number::fromNumber($b);
 
        if ($aNum->isDecimal() || $bNum->isDecimal()) {
            $integersCompared = gmp_cmp($aNum->getIntegerPart(), $bNum->getIntegerPart());
            if ($integersCompared !== 0) {
                return $integersCompared;
            }
 
            $aNumFractional = $aNum->getFractionalPart() === '' ? '0' : $aNum->getFractionalPart();
            $bNumFractional = $bNum->getFractionalPart() === '' ? '0' : $bNum->getFractionalPart();
 
            return gmp_cmp($aNumFractional, $bNumFractional);
        }
 
        return gmp_cmp($a, $b);
    }
 
    public function add($amount, $addend)
    {
        return gmp_strval(gmp_add($amount, $addend));
    }
 
    public function subtract($amount, $subtrahend)
    {
        return gmp_strval(gmp_sub($amount, $subtrahend));
    }
 
    public function multiply($amount, $multiplier)
    {
        $multiplier = Number::fromNumber($multiplier);
 
        if ($multiplier->isDecimal()) {
            $decimalPlaces = strlen($multiplier->getFractionalPart());
            $multiplierBase = $multiplier->getIntegerPart();
 
            if ($multiplierBase) {
                $multiplierBase .= $multiplier->getFractionalPart();
            } else {
                $multiplierBase = ltrim($multiplier->getFractionalPart(), '0');
            }
 
            $resultBase = gmp_strval(gmp_mul(gmp_init($amount), gmp_init($multiplierBase)));
 
            if ('0' === $resultBase) {
                return '0';
            }
 
            $result = substr($resultBase, $decimalPlaces * -1);
            $resultLength = strlen($result);
            if ($decimalPlaces > $resultLength) {
                return '0.'.str_pad('', $decimalPlaces - $resultLength, '0').$result;
            }
 
            return substr($resultBase, 0, $decimalPlaces * -1).'.'.$result;
        }
 
        return gmp_strval(gmp_mul(gmp_init($amount), gmp_init((string) $multiplier)));
    }
 
    public function divide($amount, $divisor)
    {
        $divisor = Number::fromNumber($divisor);
 
        if ($divisor->isDecimal()) {
            $decimalPlaces = strlen($divisor->getFractionalPart());
 
            if ($divisor->getIntegerPart()) {
                $divisor = new Number($divisor->getIntegerPart().$divisor->getFractionalPart());
            } else {
                $divisor = new Number(ltrim($divisor->getFractionalPart(), '0'));
            }
 
            $amount = gmp_strval(gmp_mul(gmp_init($amount), gmp_init('1'.str_pad('', $decimalPlaces, '0'))));
        }
 
        list($integer, $remainder) = gmp_div_qr(gmp_init($amount), gmp_init((string) $divisor));
 
        if (gmp_cmp($remainder, '0') === 0) {
            return gmp_strval($integer);
        }
 
        $divisionOfRemainder = gmp_strval(
            gmp_div_q(
                gmp_mul($remainder, gmp_init('1'.str_pad('', $this->scale, '0'))),
                gmp_init((string) $divisor),
                GMP_ROUND_MINUSINF
            )
        );
 
        if ($divisionOfRemainder[0] === '-') {
            $divisionOfRemainder = substr($divisionOfRemainder, 1);
        }
 
        return gmp_strval($integer).'.'.str_pad($divisionOfRemainder, $this->scale, '0', STR_PAD_LEFT);
    }
 
    public function ceil($number)
    {
        $number = Number::fromNumber($number);
 
        if ($number->isInteger()) {
            return (string) $number;
        }
 
        if ($number->isNegative()) {
            return $this->add($number->getIntegerPart(), '0');
        }
 
        return $this->add($number->getIntegerPart(), '1');
    }
 
    public function floor($number)
    {
        $number = Number::fromNumber($number);
 
        if ($number->isInteger()) {
            return (string) $number;
        }
 
        if ($number->isNegative()) {
            return $this->add($number->getIntegerPart(), '-1');
        }
 
        return $this->add($number->getIntegerPart(), '0');
    }
 
    public function absolute($number)
    {
        return ltrim($number, '-');
    }
 
    public function round($number, $roundingMode)
    {
        $number = Number::fromNumber($number);
 
        if ($number->isInteger()) {
            return (string) $number;
        }
 
        if ($number->isHalf() === false) {
            return $this->roundDigit($number);
        }
 
        if (Money::ROUND_HALF_UP === $roundingMode) {
            return $this->add(
                $number->getIntegerPart(),
                $number->getIntegerRoundingMultiplier()
            );
        }
 
        if (Money::ROUND_HALF_DOWN === $roundingMode) {
            return $this->add($number->getIntegerPart(), '0');
        }
 
        if (Money::ROUND_HALF_EVEN === $roundingMode) {
            if ($number->isCurrentEven()) {
                return $this->add($number->getIntegerPart(), '0');
            }
 
            return $this->add(
                $number->getIntegerPart(),
                $number->getIntegerRoundingMultiplier()
            );
        }
 
        if (Money::ROUND_HALF_ODD === $roundingMode) {
            if ($number->isCurrentEven()) {
                return $this->add(
                    $number->getIntegerPart(),
                    $number->getIntegerRoundingMultiplier()
                );
            }
 
            return $this->add($number->getIntegerPart(), '0');
        }
 
        if (Money::ROUND_HALF_POSITIVE_INFINITY === $roundingMode) {
            if ($number->isNegative()) {
                return $this->add(
                    $number->getIntegerPart(),
                    '0'
                );
            }
 
            return $this->add(
                $number->getIntegerPart(),
                $number->getIntegerRoundingMultiplier()
            );
        }
 
        if (Money::ROUND_HALF_NEGATIVE_INFINITY === $roundingMode) {
            if ($number->isNegative()) {
                return $this->add(
                    $number->getIntegerPart(),
                    $number->getIntegerRoundingMultiplier()
                );
            }
 
            return $this->add(
                $number->getIntegerPart(),
                '0'
            );
        }
 
        throw new \InvalidArgumentException('Unknown rounding mode');
    }
 
    private function roundDigit(Number $number)
    {
        if ($number->isCloserToNext()) {
            return $this->add(
                $number->getIntegerPart(),
                $number->getIntegerRoundingMultiplier()
            );
        }
 
        return $this->add($number->getIntegerPart(), '0');
    }
 
    public function share($amount, $ratio, $total)
    {
        return $this->floor($this->divide($this->multiply($amount, $ratio), $total));
    }
 
    public function mod($amount, $divisor)
    {
        // gmp_mod() only calculates non-negative integers, so we use absolutes
        $remainder = gmp_mod($this->absolute($amount), $this->absolute($divisor));
 
        // If the amount was negative, we negate the result of the modulus operation
        $amount = Number::fromNumber($amount);
 
        if ($amount->isNegative()) {
            $remainder = gmp_neg($remainder);
        }
 
        return gmp_strval($remainder);
    }
 
    public function it_divides_bug538()
    {
        $this->assertSame('-4.54545454545455', $this->getCalculator()->divide('-500', 110));
    }
}