bccomp

(PHP 4, PHP 5, PHP 7, PHP 8)

bccompCompare two arbitrary precision numbers

Опис

bccomp(string $num1, string $num2, ?int $scale = null): int

Compares num1 to num2 and returns the result of the comparison as an integer.

Параметри

num1

The left operand, as a string.

num2

The right operand, as a string.

scale

Необов'язковий параметр, яким вказується кількість знаків після крапки в результаті. Якщо опущено, застосовується межа, що встановлена глобально функцією bcscale(), або ж 0, якщо межа ще не встановлена.

Значення, що повертаються

Returns 0 if both operands are equal, 1 if num1 is greater than num2, -1 otherwise.

Помилки/виключення

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.

Журнал змін

Версія Опис
8.0.0 scale is now nullable.

Приклади

Приклад #1 bccomp() example

<?php

echo bccomp('1', '2') . "\n"; // -1
echo bccomp('1.00001', '1', 3); // 0
echo bccomp('1.00001', '1', 5); // 1

?>
add a note

User Contributed Notes 4 notes

up
25
Robert Lozyniak
14 years ago
Beware that negative zero does not compare equal to positive zero.
up
15
aaugrin at gmail dot com
6 years ago
BEWARE! left and right operand is string!! so number in E-notation like 9.012E-6 need to be converted with sprintf('%F') to string
up
0
mm at mobelt dot com
20 days ago
If you want to compare 2 decimals for equality, bccomp does not works as expected:

bccomp("1.000000000000000","0.999999999999999",2)

returns 1

Instead, use

bcsub("1.000000000000000","0.999999999999999",2) == 0
up
-3
m dot kaczanowski at alianet dot pl
15 years ago
Improvement of functions bcmax() and bcmin() originaly written by frank at booksku dot com

<?php

function bcmax() {
$args = func_get_args();
if (
count($args)==0) return false;
$max = $args[0];
foreach(
$args as $value) {
if (
bccomp($value, $max)==1) {
$max = $value;
}
}
return
$max;
}

function
bcmin() {
$args = func_get_args();
if (
count($args)==0) return false;
$min = $args[0];
foreach(
$args as $value) {
if (
bccomp($min, $value)==1) {
$min = $value;
}
}
return
$min;
}
?>
To Top