brick/math 0.15.0

on PHP Packagist

💥 Breaking changes

• floating-point inputs are no longer accepted by of() and arithmetic methods, use of((string) $float) to get the same behaviour as before (#105)
• BigRational is now always simplified to lowest terms: all operations, including of() and ofFraction(), now return a fraction in its simplest form (e.g. 2/3 instead of 4/6)
• BigDecimal::dividedBy() now requires the $scale parameter
• BigInteger::sqrt() and BigDecimal::sqrt() now default to RoundingMode::Unnecessary, explicitly pass RoundingMode::Down to get the previous behaviour
• BigInteger::mod() now uses Euclidean modulo semantics: the modulus must be strictly positive, and the result is always non-negative; this change aligns with Java's BigInteger.mod() behaviour
• BigInteger::mod(), modInverse() and modPow() now throw InvalidArgumentException (instead of NegativeNumberException) for negative modulus/exponent arguments
• MathException is now an interface instead of a class
• BigDecimal::getPrecision() now returns 1 for zero values
• BigNumber::min(), max() and sum() now throw an ArgumentCountError when called with no arguments (previously threw InvalidArgumentException)
• BigInteger::randomBits() and randomRange() now throw RandomSourceException when random byte generation fails or returns invalid data

Deprecated API elements removed:

• deprecated method BigInteger::testBit() has been removed, use isBitSet() instead
• deprecated method BigInteger::gcdMultiple() has been removed, use gcdAll() instead
• deprecated method BigDecimal::exactlyDividedBy() has been removed, use dividedByExact() instead
• deprecated method BigDecimal::getIntegralPart() has been removed (will be re-introduced as returning BigInteger in 0.16)
• deprecated method BigDecimal::getFractionalPart() has been removed (will be re-introduced as returning BigDecimal with a different meaning in 0.16)
• deprecated method BigDecimal::stripTrailingZeros() has been removed, use strippedOfTrailingZeros() instead
• deprecated method BigRational::nd() has been removed, use ofFraction() instead
• deprecated method BigRational::quotient() has been removed, use getIntegralPart() instead
• deprecated method BigRational::remainder() has been removed, use $number->getNumerator()->remainder($number->getDenominator()) instead
• deprecated method BigRational::quotientAndRemainder() has been removed, use $number->getNumerator()->quotientAndRemainder($number->getDenominator()) instead
• deprecated RoundingMode upper snake case constants (e.g. HALF_UP) have been removed, use the pascal case version (e.g. HalfUp) instead

The following breaking changes only affect you if you're using named arguments:

• BigInteger::mod() now uses $modulus as the parameter name
• BigInteger::modInverse() now uses $modulus as the parameter name
• BigInteger::modPow() now uses $exponent and $modulus as parameter names
• BigInteger::shiftedLeft() now uses $bits as the parameter name
• BigInteger::shiftedRight() now uses $bits as the parameter name
• BigInteger::isBitSet() now uses $bitIndex as the parameter name
• BigInteger::randomBits() now uses $bitCount as the parameter name
• BigDecimal::withPointMovedLeft() now uses $places as the parameter name
• BigDecimal::withPointMovedRight() now uses $places as the parameter name

The following breaking changes are unlikely to affect you:

• DivisionByZeroException::modulusMustNotBeZero() has been renamed to zeroModulus()
• DivisionByZeroException::denominatorMustNotBeZero() has been renamed to zeroDenominator()
• IntegerOverflowException::toIntOverflow() has been renamed to integerOutOfRange()
• RoundingNecessaryException::roundingNecessary() has been removed

🗑️ Deprecations

• Method BigRational::simplified() is deprecated, as it is now a no-op

✨ New features

• BigInteger::power(), BigDecimal::power() and BigRational::power() no longer enforce an exponent limit
• BigInteger::shiftedLeft() and BigInteger::shiftedRight() no longer enforce a limit on the number of bits
• BigRational::power() now accepts negative exponents
• New exception: InvalidArgumentException for invalid argument errors
• New exception: NoInverseException for modular inverse errors
• New exception: RandomSourceException for random source errors

👌 Improvements

• Narrowed parameter and return types with static analysis annotations (#108 by @simPod)