BcMath\Number::mul

(PHP 8 >= 8.4.0)

BcMath\Number::mulMultiplica um número de precisão arbitrária

Descrição

public BcMath\Number::mul(BcMath\Number|string|int $num, ?int $scale = null): BcMath\Number

Multiplica $this por num.

Parâmetros

num
O multiplicador.
scale
O parâmetro scale especifica explicitamente a escala para os resultados de cálculo. Se scale for null, o resultado do cálculo será definido automaticamente.

Valor Retornado

Retorna o resultado da multiplicação como um novo objeto BcMath\Number.

Quando a BcMath\Number::scale do objeto resultante é definida automaticamente, a soma das BcMath\Number::scales dos dois valores da multiplicação é usada.

Isto é, se as BcMath\Number::scales de dois valores forem 2 e 5 respectivamente, a BcMath\Number::scale do resultado será 7.

Erros/Exceções

Este método lança uma exceção ValueError nos seguintes casos:

  • num é uma string e não é uma string numérica BCMath bem formada
  • scale está fora do intervalo válido
  • BcMath\Number::scale do objeto resultante está fora do intervalo válido

Exemplos

Exemplo #1 Exemplo de BcMath\Number::mul() quando scale não é especificado

<?php
$number
= new BcMath\Number('1.234');

$ret1 = $number->mul(new BcMath\Number('2.3456'));
$ret2 = $number->mul('-3.4');
$ret3 = $number->mul(7);

var_dump($number, $ret1, $ret2, $ret3);
?>

O exemplo acima produzirá:

object(BcMath\Number)#1 (2) {
  ["value"]=>
  string(5) "1.234"
  ["scale"]=>
  int(3)
}
object(BcMath\Number)#3 (2) {
  ["value"]=>
  string(9) "2.8944704"
  ["scale"]=>
  int(7)
}
object(BcMath\Number)#2 (2) {
  ["value"]=>
  string(7) "-4.1956"
  ["scale"]=>
  int(4)
}
object(BcMath\Number)#4 (2) {
  ["value"]=>
  string(5) "8.638"
  ["scale"]=>
  int(3)
}

Exemplo #2 Exemplo de BcMath\Number::mul() especificando scale explicitamente

<?php
$number
= new BcMath\Number('1.234');

$ret1 = $number->mul(new BcMath\Number('2.3456'), 1);
$ret2 = $number->mul('-3.4', 10);
$ret3 = $number->mul(7, 0);

var_dump($number, $ret1, $ret2, $ret3);
?>

O exemplo acima produzirá:

object(BcMath\Number)#1 (2) {
  ["value"]=>
  string(5) "1.234"
  ["scale"]=>
  int(3)
}
object(BcMath\Number)#3 (2) {
  ["value"]=>
  string(3) "2.8"
  ["scale"]=>
  int(1)
}
object(BcMath\Number)#2 (2) {
  ["value"]=>
  string(13) "-4.1956000000"
  ["scale"]=>
  int(10)
}
object(BcMath\Number)#4 (2) {
  ["value"]=>
  string(1) "8"
  ["scale"]=>
  int(0)
}

Veja Também

adicione uma nota

Notas Enviadas por Usuários (em inglês)

Não há notas de usuários para esta página.
To Top