bccomp
Compare two arbitrary precision numbers
Description
int bccomp(string $num1, string $num2, intnull $scale = null)
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
Returns 0 if both operands are equal,
1 if num1 is greater than
num2, -1 otherwise.
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 bccomp example
<?php
echo bccomp('1', '2') . "\n"; // -1
echo bccomp('1.00001', '1', 3); // 0
echo bccomp('1.00001', '1', 5); // 1
?>