BcMath\Number::sub

(PHP 8 >= 8.4.0)

BcMath\Number::sub — Sustrae un número de precisión arbitraria

Descripción

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

Sustrae num de $this.

Parámetros

num: El valor a sustraer.
scale: BcMath\Number::scale especificado explícitamente para los resultados del cálculo. Si null, el BcMath\Number::scale del resultado del cálculo será definido automáticamente.

Valores devueltos

Devuelve el resultado de la sustracción como un nuevo objeto BcMath\Number.

Cuando el BcMath\Number::scale del resultado se define automáticamente, se utiliza el mayor BcMath\Number::scale de los dos números utilizados para la sustracción.

Es decir, si los BcMath\Number::scale de dos valores son 2 y 5 respectivamente, el BcMath\Number::scale del resultado será 5.

Errores/Excepciones

Este método lanza una ValueError en los siguientes casos:

num es un string y no es una cadena numérica BCMath bien formada
scale está fuera del rango válido

Ejemplos

Ejemplo #1 Ejemplo de BcMath\Number::sub() cuando scale no está especificado

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

$ret1 = $number->sub(new BcMath\Number('2.34567'));
$ret2 = $number->sub('-3.456');
$ret3 = $number->sub(7);

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

El ejemplo anterior mostrará:

object(BcMath\Number)#1 (2) {
  ["value"]=>
  string(5) "1.234"
  ["scale"]=>
  int(3)
}
object(BcMath\Number)#3 (2) {
  ["value"]=>
  string(8) "-1.11167"
  ["scale"]=>
  int(5)
}
object(BcMath\Number)#2 (2) {
  ["value"]=>
  string(5) "4.690"
  ["scale"]=>
  int(3)
}
object(BcMath\Number)#4 (2) {
  ["value"]=>
  string(6) "-5.766"
  ["scale"]=>
  int(3)
}

Ejemplo #2 Ejemplo de BcMath\Number::sub() especificando scale explícitamente

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

$ret1 = $number->sub(new BcMath\Number('2.34567'), 1);
$ret2 = $number->sub('-3.456', 10);
$ret3 = $number->sub(7, 0);

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

El ejemplo anterior mostrará:

object(BcMath\Number)#1 (2) {
  ["value"]=>
  string(5) "1.234"
  ["scale"]=>
  int(3)
}
object(BcMath\Number)#3 (2) {
  ["value"]=>
  string(4) "-1.1"
  ["scale"]=>
  int(1)
}
object(BcMath\Number)#2 (2) {
  ["value"]=>
  string(12) "4.6900000000"
  ["scale"]=>
  int(10)
}
object(BcMath\Number)#4 (2) {
  ["value"]=>
  string(2) "-5"
  ["scale"]=>
  int(0)
}

Ver también

bcsub() - Resta un número de precisión arbitraria de otro
BcMath\Number::add() - Añadir un número de precisión arbitraria