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.

BcMath\Number::add — Adds an arbitrary precision number
BcMath\Number::ceil — Rounds up an arbitrary precision number
BcMath\Number::compare — Compares two arbitrary precision numbers
BcMath\Number::__construct — Creates a BcMath\Number object
BcMath\Number::div — Divides by an arbitrary precision number
BcMath\Number::divmod — Gets the quotient and modulus of an arbitrary precision number
BcMath\Number::floor — Rounds down an arbitrary precision number
BcMath\Number::mod — Gets the modulus of an arbitrary precision number
BcMath\Number::mul — Multiplies an arbitrary precision number
BcMath\Number::pow — Raises an arbitrary precision number
BcMath\Number::powmod — Raises an arbitrary precision number, reduced by a specified modulus
BcMath\Number::round — Rounds an arbitrary precision number
BcMath\Number::__serialize — Serializes a BcMath\Number object
BcMath\Number::sqrt — Gets the square root of an arbitrary precision number
BcMath\Number::sub — Subtracts an arbitrary precision number
BcMath\Number::__toString — Converts BcMath\Number to string
BcMath\Number::__unserialize — Deserializes a data parameter into a BcMath\Number object

Found A Problem?

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

＋add a note

User Contributed Notes 1 note

down

harl at gmail dot com ¶

11 months 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.