bccomp

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

bccompCompara dois números de precisão arbitrária

Descrição

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

Compara num1 com num2 e retorna o resultado da comparação como um inteiro.

Parâmetros

num1

O operando da esquerda, como uma string.

num2

O operando da direita, como uma string.

scale
Este parâmetro opcional é usado para definir o número de dígitos após a casa decimal no resultado. Se for igual a null o padrão será a escala definida com a função bcscale() ou, em último caso, o valor da diretiva INI bcmath.scale.

Valor Retornado

Retorna 0 se ambos os operandos forem iguais, 1 se num1 for maior que num2, -1 para o restante.

Erros/Exceções

Esta função lança uma exceção ValueError nos seguintes casos:

  • num1 ou num2 não for uma string numérica BCMath bem formada.
  • scale estiver fora do intervalo válido.

Registro de Alterações

Versão Descrição
8.0.0 scale pode ser nulo.

Exemplos

Exemplo #1 Exemplo de bccomp()

<?php

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

?>