1. class
  2. BcMath
  3. \
  4. Number

Number

Since: 8.4

final class Number implements Stringable (View source)

Properties

numeric-string $value
int $scale

Methods

__construct(string|int $num)

No description

Number
add(Number|string|int $num, int|null $scale = null)

No description

Number
sub(Number|string|int $num, int|null $scale = null)

No description

Number
mul(Number|string|int $num, int|null $scale = null)

No description

Number
div(Number|string|int $num, int|null $scale = null)

No description

Number
mod(Number|string|int $num, int|null $scale = null)

No description

array
divmod(Number|string|int $num, int|null $scale = null)

No description

Number
powmod(Number|string|int $exponent, Number|string|int $modulus, int|null $scale = null)

No description

Number
pow(Number|string|int $exponent, int|null $scale = null)

No description

Number
sqrt(int|null $scale = null)

No description

Number
floor()

Rounds down an arbitrary precision number

Number
ceil()

Rounds up an arbitrary precision number

Number
round(int $precision = 0, RoundingMode $mode = \RoundingMode::HalfAwayFromZero)

No description

int
compare(Number|string|int $num, int|null $scale = null)

No description

string
__toString()

Converts BcMath\Number to string

array
__serialize()

No description

void
__unserialize(array $data)

No description

Details

at line 286
__construct(string|int $num)

No description

Parameters

string|int $num

Exceptions

ValueError

at line 292
Number add(Number|string|int $num, int|null $scale = null)

No description

Parameters

Number|string|int $num
int|null $scale

Return Value

Number

Exceptions

ValueError

at line 298
Number sub(Number|string|int $num, int|null $scale = null)

No description

Parameters

Number|string|int $num
int|null $scale

Return Value

Number

Exceptions

ValueError

at line 304
Number mul(Number|string|int $num, int|null $scale = null)

No description

Parameters

Number|string|int $num
int|null $scale

Return Value

Number

Exceptions

ValueError

at line 311
Number div(Number|string|int $num, int|null $scale = null)

No description

Parameters

Number|string|int $num
int|null $scale

Return Value

Number

Exceptions

DivisionByZeroError
ValueError

at line 318
Number mod(Number|string|int $num, int|null $scale = null)

No description

Parameters

Number|string|int $num
int|null $scale

Return Value

Number

Exceptions

DivisionByZeroError
ValueError

at line 326
array divmod(Number|string|int $num, int|null $scale = null)

No description

Parameters

Number|string|int $num
int|null $scale

Return Value

array

Exceptions

DivisionByZeroError
ValueError

at line 334
Number powmod(Number|string|int $exponent, Number|string|int $modulus, int|null $scale = null)

No description

Parameters

Number|string|int $exponent
Number|string|int $modulus
int|null $scale

Return Value

Number

Exceptions

DivisionByZeroError
ValueError

at line 341
Number pow(Number|string|int $exponent, int|null $scale = null)

No description

Parameters

Number|string|int $exponent
int|null $scale

Return Value

Number

Exceptions

DivisionByZeroError
ValueError

at line 344
Number sqrt(int|null $scale = null)

No description

Parameters

int|null $scale

Return Value

Number

Exceptions

ValueError

at line 355
Number floor()

Rounds down an arbitrary precision number

Returns the next highest integer value by rounding down $this if necessary.

Return Value

Number

Returns the result as a new BcMath\Number object. The BcMath\Number::scale of the result is always 0.

at line 366
Number ceil()

Rounds up an arbitrary precision number

Returns the next highest integer value by rounding up $this if necessary.

Return Value

Number

Returns the result as a new BcMath\Number object. The BcMath\Number::scale of the result is always 0.

at line 369
Number round(int $precision = 0, RoundingMode $mode = \RoundingMode::HalfAwayFromZero)

No description

Parameters

int $precision
RoundingMode $mode

Return Value

Number

Exceptions

ValueError

at line 376
int compare(Number|string|int $num, int|null $scale = null)

No description

Parameters

Number|string|int $num
int|null $scale

Return Value

int

Returns -1, 0, or 1

Exceptions

ValueError

at line 383
string __toString()

Converts BcMath\Number to string

Return Value

string

Returns string representation of the object that implements this interface (and/or "__toString" magic method).

at line 386
array __serialize()

No description

Return Value

array

at line 389
void __unserialize(array $data)

No description

Parameters

array $data

Return Value

void