bcsub
(PHP 4, PHP 5)
bcsub — Subtract one arbitrary precision number from another
Description
string bcsub
( string
$left_operand = ""
, string $right_operand = ""
[, int $scale = int
] )
Subtracts the right_operand from the
left_operand.
Parameters
-
left_operand -
The left operand, as a string.
-
right_operand -
The right operand, as a string.
-
scale -
This optional parameter is used to set the number of digits after the decimal place in the result. You can also set the global default scale for all functions by using bcscale().
Return Values
The result of the subtraction, as a string.
Examples
Example #1 bcsub() example
<?php
$a = '1.234';
$b = '5';
echo bcsub($a, $b); // -3
echo bcsub($a, $b, 4); // -3.7660
?>
Коментарии
The parameter order here is probably fairly obvious to most people (subtract right from left), but to clarify with a simple use case since I was struggling with this at the end of a long day:
<?php
echo bcsub('7', '5'); // 7 - 5 = '2'
echo bcsub('12', '17'); // 12 - 17 = '-5'
?>
Provide the parameters in the same order you would when using a normal subtraction operator.
Please note that bcsub will fail in non-obvious ways if it's fed something that cannot be converted to a number. For instance:
bcsub('yes', 'no') === '0'
Yes, if you put garbage in, you get garbage out. Just don't expect bcsub to throw an error when you feed it an entirely non-numeric value.