bcmod

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

bcmodObtém o resto de uma divisão com precisão arbitrária

Descrição

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

Obtém o resto da divisão de num1 por num2. O resultado tem o mesmo sinal de num1.

Parâmetros

num1

O operando da esquerda, como uma string.

num2

O operando da direita, como uma string.

scale
Este parâmetro é usado para definir o número de dígitos após o separador de decimais do resultado. Se for null, será usada a escala padrão definida com bcscale(), ou será usado o valor da diretiva INI bcmath.scale.

Valor Retornado

Retorna o resto como uma string.

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.

Esta função lança uma exceção DivisionByZeroError se num2 for igual a 0.

Registro de Alterações

Versão Descrição
8.0.0 scale pode ser null.
8.0.0 Dividir por 0 agora lança uma exceção DivisionByZeroError ao invés de retornar null.
7.2.0 num1 e num2 não são mais truncados para inteiro, de forma que o comportamento de bcmod() é o mesmo de fmod() ao invés do operador %.
7.2.0 O parâmetro scale foi adicionado.

Exemplos

Exemplo #1 Exemplo de bcmod()

<?php
bcscale
(0);
echo
bcmod( '5', '3'); // 2
echo bcmod( '5', '-3'); // 2
echo bcmod('-5', '3'); // -2
echo bcmod('-5', '-3'); // -2
?>

Exemplo #2 Exemplo de bcmod() com decimais

<?php
bcscale
(1);
echo
bcmod('5.7', '1.3'); // 0.5 no PHP 7.2.0; anteriormente 0
?>

Veja Também

  • bcdiv() - Divide dois números de precisão arbitrária
  • bcdivmod() - Obtém o quociente e o módulo de um número de precisão arbitrário
  • BcMath\Number::mod() - Obtém o resto de um número de precisão arbitrária