BigRational

An arbitrarily large rational number.

This class is immutable.

• Full name: \Brick\Math\BigRational
• Parent class: \Brick\Math\BigNumber
• This class is marked as final and can't be subclassed
• This class is a Final class

Properties

numerator

The numerator.

private \Brick\Math\BigInteger $numerator

---

denominator

The denominator. Always strictly positive.

private \Brick\Math\BigInteger $denominator

---

Methods

__construct

Protected constructor. Use a factory method to obtain an instance.

protected __construct(\Brick\Math\BigInteger $numerator, \Brick\Math\BigInteger $denominator, bool $checkDenominator): mixed

Parameters:

Parameter	Type	Description
$numerator	\Brick\Math\BigInteger	The numerator.
$denominator	\Brick\Math\BigInteger	The denominator.
$checkDenominator	bool	Whether to check the denominator for negative and zero.

Throws:

If the denominator is zero.

• DivisionByZeroException

---

of

Creates a BigRational of the given value.

public static of(\Brick\Math\BigNumber|int|float|string $value): \Brick\Math\BigRational

• This method is static.

Parameters:

Parameter	Type	Description
$value	\Brick\Math\BigNumber|int|float|string

Throws:

If the value cannot be converted to a BigRational.

• MathException

---

nd

Creates a BigRational out of a numerator and a denominator.

public static nd(\Brick\Math\BigNumber|int|float|string $numerator, \Brick\Math\BigNumber|int|float|string $denominator): \Brick\Math\BigRational

If the denominator is negative, the signs of both the numerator and the denominator will be inverted to ensure that the denominator is always positive.

• This method is static.

Parameters:

Parameter	Type	Description
$numerator	\Brick\Math\BigNumber|int|float|string	The numerator. Must be convertible to a BigInteger.
$denominator	\Brick\Math\BigNumber|int|float|string	The denominator. Must be convertible to a BigInteger.

Throws:

If an argument does not represent a valid number.

• NumberFormatException

If an argument represents a non-integer number.

• RoundingNecessaryException

If the denominator is zero.

• DivisionByZeroException

---

zero

Returns a BigRational representing zero.

public static zero(): \Brick\Math\BigRational

• This method is static.

---

one

Returns a BigRational representing one.

public static one(): \Brick\Math\BigRational

• This method is static.

---

ten

Returns a BigRational representing ten.

public static ten(): \Brick\Math\BigRational

• This method is static.

---

getNumerator

public getNumerator(): \Brick\Math\BigInteger

---

getDenominator

public getDenominator(): \Brick\Math\BigInteger

---

quotient

Returns the quotient of the division of the numerator by the denominator.

public quotient(): \Brick\Math\BigInteger

---

remainder

Returns the remainder of the division of the numerator by the denominator.

public remainder(): \Brick\Math\BigInteger

---

quotientAndRemainder

Returns the quotient and remainder of the division of the numerator by the denominator.

public quotientAndRemainder(): \Brick\Math\BigInteger[]

---

plus

Returns the sum of this number and the given one.

public plus(\Brick\Math\BigNumber|int|float|string $that): \Brick\Math\BigRational

Parameters:

Parameter	Type	Description
$that	\Brick\Math\BigNumber|int|float|string	The number to add.

Throws:

If the number is not valid.

• MathException

---

minus

Returns the difference of this number and the given one.

public minus(\Brick\Math\BigNumber|int|float|string $that): \Brick\Math\BigRational

Parameters:

Parameter	Type	Description
$that	\Brick\Math\BigNumber|int|float|string	The number to subtract.

Throws:

If the number is not valid.

• MathException

---

multipliedBy

Returns the product of this number and the given one.

public multipliedBy(\Brick\Math\BigNumber|int|float|string $that): \Brick\Math\BigRational

Parameters:

Parameter	Type	Description
$that	\Brick\Math\BigNumber|int|float|string	The multiplier.

Throws:

If the multiplier is not a valid number.

• MathException

---

dividedBy

Returns the result of the division of this number by the given one.

public dividedBy(\Brick\Math\BigNumber|int|float|string $that): \Brick\Math\BigRational

Parameters:

Parameter	Type	Description
$that	\Brick\Math\BigNumber|int|float|string	The divisor.

Throws:

If the divisor is not a valid number, or is zero.

• MathException

---

power

Returns this number exponentiated to the given value.

public power(int $exponent): \Brick\Math\BigRational

Parameters:

Parameter	Type	Description
$exponent	int

Throws:

If the exponent is not in the range 0 to 1,000,000.

• InvalidArgumentException

---

reciprocal

Returns the reciprocal of this BigRational.

public reciprocal(): \Brick\Math\BigRational

The reciprocal has the numerator and denominator swapped.

Throws:

If the numerator is zero.

• DivisionByZeroException

---

abs

Returns the absolute value of this BigRational.

public abs(): \Brick\Math\BigRational

---

negated

Returns the negated value of this BigRational.

public negated(): \Brick\Math\BigRational

---

simplified

Returns the simplified value of this BigRational.

public simplified(): \Brick\Math\BigRational

---

compareTo

Compares this number to the given one.

public compareTo(\Brick\Math\BigNumber|int|float|string $that): int

Parameters:

Parameter	Type	Description
$that	\Brick\Math\BigNumber|int|float|string

Return Value:

[-1,0,1] If $this is lower than, equal to, or greater than $that.

---

getSign

Returns the sign of this number.

public getSign(): int

Return Value:

-1 if the number is negative, 0 if zero, 1 if positive.

---

toBigInteger

Converts this number to a BigInteger.

public toBigInteger(): \Brick\Math\BigInteger

---

toBigDecimal

Converts this number to a BigDecimal.

public toBigDecimal(): \Brick\Math\BigDecimal

---

toBigRational

Converts this number to a BigRational.

public toBigRational(): \Brick\Math\BigRational

---

toScale

Converts this number to a BigDecimal with the given scale, using rounding if necessary.

public toScale(int $scale, int $roundingMode = RoundingMode::UNNECESSARY): \Brick\Math\BigDecimal

Parameters:

Parameter	Type	Description
$scale	int	The scale of the resulting BigDecimal.
$roundingMode	int	A RoundingMode constant.

---

toInt

Returns the exact value of this number as a native integer.

public toInt(): int

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.

---

toFloat

Returns an approximation of this number as a floating-point value.

public toFloat(): float

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.

---

__toString

Returns a string representation of this number.

public __toString(): string

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.

---

Inherited methods

of

Creates a BigNumber of the given value.

public static of(\Brick\Math\BigNumber|int|float|string $value): \Brick\Math\BigNumber

The concrete return type is dependent on the given value, with the following rules:

• BigNumber instances are returned as is
• integer numbers are returned as BigInteger
• 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

• This method is static.

Parameters:

Parameter	Type	Description
$value	\Brick\Math\BigNumber|int|float|string

Throws:

If the format of the number is not valid.

• NumberFormatException

If the value represents a rational number with a denominator of zero.

• DivisionByZeroException

---

floatToString

Safely converts float to string, avoiding locale-dependent issues.

private static floatToString(float $float): string

• This method is static.

Parameters:

Parameter	Type	Description
$float	float

See Also:

• https://github.com/brick/math/pull/20 -

---

min

Returns the minimum of the given values.

public static min(\Brick\Math\BigNumber|int|float|string $values): static

• This method is static.

Parameters:

Parameter	Type	Description
$values	\Brick\Math\BigNumber|int|float|string	The numbers to compare. All the numbers need to be convertible to an instance of the class this method is called on.

Throws:

If no values are given.

• InvalidArgumentException

If an argument is not valid.

• MathException

---

max

Returns the maximum of the given values.

public static max(\Brick\Math\BigNumber|int|float|string $values): static

• This method is static.

Parameters:

Parameter	Type	Description
$values	\Brick\Math\BigNumber|int|float|string	The numbers to compare. All the numbers need to be convertible to an instance of the class this method is called on.

Throws:

If no values are given.

• InvalidArgumentException

If an argument is not valid.

• MathException

---

sum

Returns the sum of the given values.

public static sum(\Brick\Math\BigNumber|int|float|string $values): static

• This method is static.

Parameters:

Parameter	Type	Description
$values	\Brick\Math\BigNumber|int|float|string	The numbers to add. All the numbers need to be convertible to an instance of the class this method is called on.

Throws:

If no values are given.

• InvalidArgumentException

If an argument is not valid.

• MathException

---

add

Adds two BigNumber instances in the correct order to avoid a RoundingNecessaryException.

private static add(\Brick\Math\BigNumber $a, \Brick\Math\BigNumber $b): \Brick\Math\BigNumber

• This method is static.

Parameters:

Parameter	Type	Description
$a	\Brick\Math\BigNumber
$b	\Brick\Math\BigNumber

---

cleanUp

Removes optional leading zeros and + sign from the given number.

private static cleanUp(string $number): string

• This method is static.

Parameters:

Parameter	Type	Description
$number	string	The number, validated as a non-empty string of digits with optional leading sign.

---

isEqualTo

Checks if this number is equal to the given one.

public isEqualTo(\Brick\Math\BigNumber|int|float|string $that): bool

Parameters:

Parameter	Type	Description
$that	\Brick\Math\BigNumber|int|float|string

---

isLessThan

Checks if this number is strictly lower than the given one.

public isLessThan(\Brick\Math\BigNumber|int|float|string $that): bool

Parameters:

Parameter	Type	Description
$that	\Brick\Math\BigNumber|int|float|string

---

isLessThanOrEqualTo

Checks if this number is lower than or equal to the given one.

public isLessThanOrEqualTo(\Brick\Math\BigNumber|int|float|string $that): bool

Parameters:

Parameter	Type	Description
$that	\Brick\Math\BigNumber|int|float|string

---

isGreaterThan

Checks if this number is strictly greater than the given one.

public isGreaterThan(\Brick\Math\BigNumber|int|float|string $that): bool

Parameters:

Parameter	Type	Description
$that	\Brick\Math\BigNumber|int|float|string

---

isGreaterThanOrEqualTo

Checks if this number is greater than or equal to the given one.

public isGreaterThanOrEqualTo(\Brick\Math\BigNumber|int|float|string $that): bool

Parameters:

Parameter	Type	Description
$that	\Brick\Math\BigNumber|int|float|string

---

isZero

Checks if this number equals zero.

public isZero(): bool

---

isNegative

Checks if this number is strictly negative.

public isNegative(): bool

---

isNegativeOrZero

Checks if this number is negative or zero.

public isNegativeOrZero(): bool

---

isPositive

Checks if this number is strictly positive.

public isPositive(): bool

---

isPositiveOrZero

Checks if this number is positive or zero.

public isPositiveOrZero(): bool

---

getSign

Returns the sign of this number.

public getSign(): int

• This method is abstract.

Return Value:

-1 if the number is negative, 0 if zero, 1 if positive.

---

compareTo

Compares this number to the given one.

public compareTo(\Brick\Math\BigNumber|int|float|string $that): int

• This method is abstract.

Parameters:

Parameter	Type	Description
$that	\Brick\Math\BigNumber|int|float|string

Return Value:

[-1,0,1] If $this is lower than, equal to, or greater than $that.

Throws:

If the number is not valid.

• MathException

---

toBigInteger

Converts this number to a BigInteger.

public toBigInteger(): \Brick\Math\BigInteger

• This method is abstract.

Throws:

If this number cannot be converted to a BigInteger without rounding.

• RoundingNecessaryException

---

toBigDecimal

Converts this number to a BigDecimal.

public toBigDecimal(): \Brick\Math\BigDecimal

• This method is abstract.

Throws:

If this number cannot be converted to a BigDecimal without rounding.

• RoundingNecessaryException

---

toBigRational

Converts this number to a BigRational.

public toBigRational(): \Brick\Math\BigRational

• This method is abstract.

---

toScale

Converts this number to a BigDecimal with the given scale, using rounding if necessary.

public toScale(int $scale, int $roundingMode = RoundingMode::UNNECESSARY): \Brick\Math\BigDecimal

• This method is abstract.

Parameters:

Parameter	Type	Description
$scale	int	The scale of the resulting BigDecimal.
$roundingMode	int	A RoundingMode constant.

Throws:

If this number cannot be converted to the given scale without rounding. This only applies when RoundingMode::UNNECESSARY is used.

• RoundingNecessaryException

---

toInt

Returns the exact value of this number as a native integer.

public toInt(): int

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.

• This method is abstract.

Throws:

If this number cannot be exactly converted to a native integer.

• MathException

---

toFloat

Returns an approximation of this number as a floating-point value.

public toFloat(): float

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.

• This method is abstract.

---

__toString

Returns a string representation of this number.

public __toString(): string

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.

• This method is abstract.

---

jsonSerialize

public jsonSerialize(): string

---

---

Automatically generated on 2025-03-18