`mini\Util\Math\Decimal` final class

Show private and protected members

Documentation

Immutable fixed-point decimal with BigInt backing

Stores value as scaled BigInt internally. Scale determines decimal places. Designed to align with SQL DECIMAL semantics for use in Table ColumnDef types.

Precision model:

Basic arithmetic (+, -, *, /, %) is exact within the specified scale
Transcendental functions (sqrt, exp, ln, pow) use iterative algorithms (Newton-Raphson, Taylor series) computed to configurable precision

Accepts BigInt|int|float|string for arithmetic operations.

Usage: $a = Decimal::of('123.45', 2); // scale 2 $b = Decimal::of('10', 4); // 10.0000, scale 4 $result = $a->add($b)->multiply(2); echo $result; // prints decimal string

Inheritance

Implements: mini\Util\Math\NumberInterface Stringable

Properties (2)

private readonly mini\Util\Math\BigInt $unscaled

private readonly int $scale

Methods (39)

private `__construct()`

Documentation missing

public static `of()`

Create from string/int with specified scale

public static `zero()`

Create zero with specified scale

public static `one()`

Create one with specified scale

public static `parse()`

Parse string/int with auto-detected scale

public `add()`

Add: result scale = max(this.scale, other.scale)

public `subtract()`

Subtract: result scale = max(this.scale, other.scale)

public `multiply()`

Multiply: result scale = this.scale + other.scale

public `divide()`

Divide with specified result scale

public `modulus()`

Modulus: result scale = max(this.scale, other.scale)

public `negate()`

Negate: -x

public `absolute()`

Absolute value

public `sqrt()`

Square root using Newton-Raphson iteration

public `exp()`

Exponential function e^x using Taylor series

public `ln()`

Natural logarithm using Newton-Raphson on exp

public `reciprocal()`

Reciprocal: 1/x

public `pow()`

Power with arbitrary exponent: x^y = exp(y * ln(x))

private `intPow()`

Integer power using binary exponentiation

public `compare()`

Compare: returns -1 if less, 0 if equal, 1 if greater

public static `compareStr()`

High-performance static comparison of decimal strings

public `equals()`

Documentation missing

public `lessThan()`

Documentation missing

public `greaterThan()`

Documentation missing

public `lessThanOrEqual()`

Documentation missing

public `greaterThanOrEqual()`

Documentation missing

public `isZero()`

Documentation missing

public `isPositive()`

Documentation missing

public `isNegative()`

Documentation missing

public `scale()`

Get the scale (number of decimal places)

public `unscaledValue()`

Get the unscaled BigInt value

public `rescale()`

Change scale with rounding

public `__toString()`

Convert to string representation

public `toFloat()`

Convert to float (may lose precision)

public `__serialize()`

Documentation missing

public `__unserialize()`

Documentation missing

private `coerce()`

Coerce input to Decimal

private `alignScales()`

Align two decimals to the same scale

private static `powerOfTen()`

Get 10^n as string (for BigInt operations)

private static `roundedDivide()`

Divide with rounding (half up by default)

Source

src/Util/Math/Decimal.php:24-817