Skip to content

feat: add types to avoid useless runtime checks #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
simPod wants to merge 1 commit into from
Closed

feat: add types to avoid useless runtime checks #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 10 additions & 26 deletions src/BigDecimal.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,16 @@
use Brick\Math\Exception\MathException;
use Brick\Math\Exception\NegativeNumberException;
use Brick\Math\Exception\RoundingNecessaryException;
use Brick\Math\Internal\Calculator;
use Brick\Math\Internal\CalculatorRegistry;
use InvalidArgumentException;
use LogicException;
use Override;

use function assert;
use function func_num_args;
use function in_array;
use function intdiv;
use function max;
use function rtrim;
use function sprintf;
use function str_pad;
use function str_repeat;
use function strlen;
Expand Down Expand Up @@ -241,10 +239,9 @@ public function multipliedBy(BigNumber|int|float|string $that): BigDecimal
* Returns the result of the division of this number by the given one, at the given scale.
*
* @param BigNumber|int|float|string $that The divisor. Must be convertible to a BigDecimal.
* @param int|null $scale The desired scale. Omitting this parameter is deprecated; it will be required in 0.15.
* @param non-negative-int|null $scale The desired scale. Omitting this parameter is deprecated; it will be required in 0.15.
* @param RoundingMode $roundingMode An optional rounding mode, defaults to Unnecessary.
*
* @throws InvalidArgumentException If the scale is negative.
* @throws MathException If the divisor is not valid, or is not convertible to a BigDecimal.
* @throws DivisionByZeroException If the divisor is zero.
* @throws RoundingNecessaryException If RoundingMode::Unnecessary is used and the result cannot be represented
Expand All @@ -268,8 +265,6 @@ public function dividedBy(BigNumber|int|float|string $that, ?int $scale = null,
E_USER_DEPRECATED,
);
$scale = $this->scale;
} elseif ($scale < 0) {
throw new InvalidArgumentException('Scale must not be negative.');
}

if ($that->value === '1' && $that->scale === 0 && $scale === $this->scale) {
Expand Down Expand Up @@ -347,6 +342,8 @@ public function dividedByExact(BigNumber|int|float|string $that): BigDecimal
}
}

assert($scale >= 0);

return $this->dividedBy($that, $scale)->strippedOfTrailingZeros();
}

Expand All @@ -355,7 +352,7 @@ public function dividedByExact(BigNumber|int|float|string $that): BigDecimal
*
* The result has a scale of `$this->scale * $exponent`.
*
* @throws InvalidArgumentException If the exponent is not in the range 0 to 1,000,000.
* @param int<0, 1000000> $exponent
*
* @pure
*/
Expand All @@ -369,14 +366,6 @@ public function power(int $exponent): BigDecimal
return $this;
}

if ($exponent < 0 || $exponent > Calculator::MAX_POWER) {
throw new InvalidArgumentException(sprintf(
'The exponent %d is not in the range 0 to %d.',
$exponent,
Calculator::MAX_POWER,
));
}

return new BigDecimal(CalculatorRegistry::get()->pow($this->value, $exponent), $this->scale * $exponent);
}

Expand Down Expand Up @@ -498,13 +487,12 @@ public function quotientAndRemainder(BigNumber|int|float|string $that): array
/**
* Returns the square root of this number, rounded to the given scale according to the given rounding mode.
*
* @param int $scale The target scale. Must be non-negative.
* @param RoundingMode $roundingMode The rounding mode to use, defaults to Down.
* ⚠️ WARNING: the default rounding mode was kept as Down for backward
* compatibility, but will change to Unnecessary in version 0.15. Pass a rounding
* mode explicitly to avoid this upcoming breaking change.
* @param non-negative-int $scale The target scale. Must be non-negative.
* @param RoundingMode $roundingMode The rounding mode to use, defaults to Down.
* ⚠️ WARNING: the default rounding mode was kept as Down for backward
* compatibility, but will change to Unnecessary in version 0.15. Pass a rounding
* mode explicitly to avoid this upcoming breaking change.
*
* @throws InvalidArgumentException If the scale is negative.
* @throws NegativeNumberException If this number is negative.
* @throws RoundingNecessaryException If RoundingMode::Unnecessary is used and the result cannot be represented
* exactly at the given scale.
Expand All @@ -522,10 +510,6 @@ public function sqrt(int $scale, RoundingMode $roundingMode = RoundingMode::Down
);
}

if ($scale < 0) {
throw new InvalidArgumentException('Scale must not be negative.');
}

if ($this->value === '0') {
return new BigDecimal('0', $scale);
}
Expand Down
53 changes: 12 additions & 41 deletions src/BigInteger.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,10 @@ protected function __construct(string $value)
*
* For bases greater than 36, and/or custom alphabets, use the fromArbitraryBase() method.
*
* @param string $number The number to convert, in the given base.
* @param int $base The base of the number, between 2 and 36.
* @param string $number The number to convert, in the given base.
* @param int<2, 36> $base The base of the number, between 2 and 36.
*
* @throws NumberFormatException If the number is empty, or contains invalid chars for the given base.
* @throws InvalidArgumentException If the base is out of range.
* @throws NumberFormatException If the number is empty, or contains invalid chars for the given base.
*
* @pure
*/
Expand All @@ -92,10 +91,6 @@ public static function fromBase(string $number, int $base): BigInteger
throw new NumberFormatException('The number must not be empty.');
}

if ($base < 2 || $base > 36) {
throw new InvalidArgumentException(sprintf('Base %d is not in range 2 to 36.', $base));
}

if ($number[0] === '-') {
$sign = '-';
$number = substr($number, 1);
Expand Down Expand Up @@ -230,19 +225,13 @@ public static function fromBytes(string $value, bool $signed = true): BigInteger
*
* Using the default random bytes generator, this method is suitable for cryptographic use.
*
* @param int $numBits The number of bits.
* @param non-negative-int $numBits The number of bits.
* @param (callable(int): string)|null $randomBytesGenerator A function that accepts a number of bytes, and returns
* a string of random bytes of the given length. Defaults
* to the `random_bytes()` function.
*
* @throws InvalidArgumentException If $numBits is negative.
*/
public static function randomBits(int $numBits, ?callable $randomBytesGenerator = null): BigInteger
{
if ($numBits < 0) {
throw new InvalidArgumentException('The number of bits must not be negative.');
}

if ($numBits === 0) {
return BigInteger::zero();
}
Expand Down Expand Up @@ -531,7 +520,7 @@ public function dividedBy(BigNumber|int|float|string $that, RoundingMode $roundi
/**
* Returns this number exponentiated to the given value.
*
* @throws InvalidArgumentException If the exponent is not in the range 0 to 1,000,000.
* @param int<0, 1000000> $exponent
*
* @pure
*/
Expand All @@ -545,14 +534,6 @@ public function power(int $exponent): BigInteger
return $this;
}

if ($exponent < 0 || $exponent > Calculator::MAX_POWER) {
throw new InvalidArgumentException(sprintf(
'The exponent %d is not in the range 0 to %d.',
$exponent,
Calculator::MAX_POWER,
));
}

return new BigInteger(CalculatorRegistry::get()->pow($this->value, $exponent));
}

Expand Down Expand Up @@ -972,7 +953,7 @@ public function not(): BigInteger
/**
* Returns the integer left shifted by a given number of bits.
*
* @throws InvalidArgumentException If the number of bits is out of range.
* @param int<-1000000, 1000000> $distance
*
* @pure
*/
Expand All @@ -992,7 +973,7 @@ public function shiftedLeft(int $distance): BigInteger
/**
* Returns the integer right shifted by a given number of bits.
*
* @throws InvalidArgumentException If the number of bits is out of range.
* @param int<-1000000, 1000000> $distance
*
* @pure
*/
Expand Down Expand Up @@ -1021,6 +1002,8 @@ public function shiftedRight(int $distance): BigInteger
* For positive BigIntegers, this is equivalent to the number of bits in the ordinary binary representation.
* Computes (ceil(log2(this < 0 ? -this : this+1))).
*
* @return non-negative-int
*
* @pure
*/
public function getBitLength(): int
Expand Down Expand Up @@ -1064,18 +1047,12 @@ public function getLowestSetBit(): int
*
* Computes ((this & (1<<n)) != 0).
*
* @param int $n The bit to test, 0-based.
*
* @throws InvalidArgumentException If the bit to test is negative.
* @param int<0, 1000000> $n The bit to test, 0-based.
*
* @pure
*/
public function isBitSet(int $n): bool
{
if ($n < 0) {
throw new InvalidArgumentException('The bit to test cannot be negative.');
}

return $this->shiftedRight($n)->isOdd();
}

Expand Down Expand Up @@ -1106,9 +1083,7 @@ public function isOdd(): bool
*
* @deprecated Use isBitSet().
*
* @param int $n The bit to test, 0-based.
*
* @throws InvalidArgumentException If the bit to test is negative.
* @param int<0, 1000000> $n The bit to test, 0-based.
*/
public function testBit(int $n): bool
{
Expand Down Expand Up @@ -1185,7 +1160,7 @@ public function toFloat(): float
*
* The output will always be lowercase for bases greater than 10.
*
* @throws InvalidArgumentException If the base is out of range.
* @param int<2, 36> $base
*
* @pure
*/
Expand All @@ -1195,10 +1170,6 @@ public function toBase(int $base): string
return $this->value;
}

if ($base < 2 || $base > 36) {
throw new InvalidArgumentException(sprintf('Base %d is out of range [2, 36]', $base));
}

return CalculatorRegistry::get()->toBase($this->value, $base);
}

Expand Down
5 changes: 2 additions & 3 deletions src/BigNumber.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,10 +441,9 @@ 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`. Must be non-negative.
* @param RoundingMode $roundingMode An optional rounding mode, defaults to Unnecessary.
* @param non-negative-int $scale The scale of the resulting `BigDecimal`. Must be non-negative.
* @param RoundingMode $roundingMode An optional rounding mode, defaults to Unnecessary.
*
* @throws InvalidArgumentException If the scale is negative.
* @throws RoundingNecessaryException If RoundingMode::Unnecessary is used, and this number cannot be converted to
* the given scale without rounding.
*
Expand Down
3 changes: 1 addition & 2 deletions src/BigRational.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
use Brick\Math\Exception\MathException;
use Brick\Math\Exception\NumberFormatException;
use Brick\Math\Exception\RoundingNecessaryException;
use InvalidArgumentException;
use LogicException;
use Override;

Expand Down Expand Up @@ -354,7 +353,7 @@ public function dividedBy(BigNumber|int|float|string $that): BigRational
/**
* Returns this number exponentiated to the given value.
*
* @throws InvalidArgumentException If the exponent is not in the range 0 to 1,000,000.
* @param int<0, 1000000> $exponent
*
* @pure
*/
Expand Down
28 changes: 0 additions & 28 deletions tests/BigDecimalTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -969,12 +969,6 @@ public static function providerDividedByWithRoundingNecessaryThrowsException():
];
}

public function testDividedByWithNegativeScaleThrowsException(): void
{
$this->expectException(InvalidArgumentException::class);
BigDecimal::of(1)->dividedBy(2, -1);
}

/**
* @param RoundingMode $roundingMode The rounding mode.
* @param string $number The number to round.
Expand Down Expand Up @@ -3040,13 +3034,6 @@ public function testSqrtOfNegativeNumber(): void
$number->sqrt(0);
}

public function testSqrtWithNegativeScale(): void
{
$number = BigDecimal::of(1);
$this->expectException(InvalidArgumentException::class);
$number->sqrt(-1);
}

public function testSqrtWithoutRoundingModeTriggersDeprecation(): void
{
$this->expectUserDeprecationMessage(
Expand Down Expand Up @@ -3148,21 +3135,6 @@ public static function providerPower(): array
];
}

#[DataProvider('providerPowerWithInvalidExponentThrowsException')]
public function testPowerWithInvalidExponentThrowsException(int $power): void
{
$this->expectException(InvalidArgumentException::class);
BigDecimal::of(1)->power($power);
}

public static function providerPowerWithInvalidExponentThrowsException(): array
{
return [
[-1],
[1000001],
];
}

/**
* @param string $number The number to scale.
* @param int $toScale The scale to apply.
Expand Down
Loading