bcsub
Subtract one arbitrary precision number from another
Description
string bcsub(string $num1
, string $num2
, intnull $scale
= null
)
Subtracts num2
from num1
.
Parameters
-
num1
-
The left operand, as a string.
-
num2
-
The right operand, as a string.
-
scale
-
This parameter is used to set the number of digits after the decimal place in the result.
If
null
, it will default to the default scale set with bcscale,
or fallback to the value of the
bcmath.scale
INI directive.
Return Values
The result of the subtraction, as a string.
Errors/Exceptions
This function throws a ValueError in the following cases:
-
num1
or num2
is not a well-formed BCMath numeric string.
-
scale
is outside the valid range.
Examples
Example #1 bcsub example
<?php
$a = '1.234';
$b = '5';
echo bcsub($a, $b); // -3
echo bcsub($a, $b, 4); // -3.7660
?>