update page now

    The BcMath\Number class

    (PHP 8 >= 8.4.0)

    Introduction

    A class for an arbitrary precision number. These objects support overloaded arithmetic and comparison operators.

    Note: This class is not affected by the bcmath.scale INI directive set in php.ini.

    Note: The behavior of an overloaded operator is the same as specifying null for the scale parameter on the corresponding method.

    Class synopsis

    namespace BcMath;
    final readonly class Number implements Stringable {
    /* Properties */
    public string $value;
    public int $scale;
    /* Methods */
    public BcMath\Number::__construct(string|int $num)
    public BcMath\Number::add(BcMath\Number|string|int $num, ?int $scale = null): BcMath\Number
    public BcMath\Number::ceil(): BcMath\Number
    public BcMath\Number::compare(BcMath\Number|string|int $num, ?int $scale = null): int
    public BcMath\Number::div(BcMath\Number|string|int $num, ?int $scale = null): BcMath\Number
    public BcMath\Number::divmod(BcMath\Number|string|int $num, ?int $scale = null): array
    public BcMath\Number::floor(): BcMath\Number
    public BcMath\Number::mod(BcMath\Number|string|int $num, ?int $scale = null): BcMath\Number
    public BcMath\Number::mul(BcMath\Number|string|int $num, ?int $scale = null): BcMath\Number
    public BcMath\Number::pow(BcMath\Number|string|int $exponent, ?int $scale = null): BcMath\Number
    public BcMath\Number::powmod(BcMath\Number|string|int $exponent, BcMath\Number|string|int $modulus, ?int $scale = null): BcMath\Number
    public BcMath\Number::round(int $precision = 0, RoundingMode $mode = RoundingMode::HalfAwayFromZero): BcMath\Number
    public BcMath\Number::__serialize(): array
    public BcMath\Number::sqrt(?int $scale = null): BcMath\Number
    public BcMath\Number::sub(BcMath\Number|string|int $num, ?int $scale = null): BcMath\Number
    public BcMath\Number::__toString(): string
    public BcMath\Number::__unserialize(array $data): void
    }

    Properties

    value
    A string representation of an arbitrary precision number.
    scale
    The scale value currently set on the object. For objects resulting from calculations, this value is automatically computed and set, unless the scale parameter was set in the calculation method.

    Table of Contents

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    5
    harl at gmail dot com
    1 year ago
    BcMath\Number is one of those classes that overloads boolean casting.
If $z = new BcMath\Number(0) then $z is considered falsy (and hence, for example, empty($z)==true) even though it is a genuine Number object.
    up
    0
    miken32 at gmail dot com
    17 days ago
    This class overloads many operators so you can do operations more naturally. But a big caveat is that the strict equality operator *does not work* as demonstrated with this code:

<?php
$sum = new BcMath\Number('23.93') + new BcMath\Number(17) - 6;
echo $sum;            // outputs 34.93

if ($sum < 99 && $sum > 34) {
    echo "foo";       // outputs foo
}

$comp = new BcMath\Number('34.93');
if ($sum === $comp) {
    echo "bar";       // outputs nothing!
}

if ($sum == $comp) {
    // yuck, don't do this
}

if ($sum->compare($comp) === 0) {
    echo "baz";       // outputs baz
}
?>
    ＋add a note
    To Top