# BcMath\Number::sub

(PHP 8 >= 8.4.0)

BcMath\Number::sub — Soustrait un nombre de précision arbitraire

### Description

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

Soustrait `num` de $this.

### Liste de paramètres

`num`
  La valeur à soustraire.
`scale`
  BcMath\Number::scale spécifié explicitement pour les résultats du calcul. Si `null`, le BcMath\Number::scale du résultat du calcul sera défini automatiquement.

### Valeurs de retour

Renvoie le résultat de la soustraction sous forme d'un nouvel objet BcMath\Number.

Lorsque le BcMath\Number::scale du résultat est défini automatiquement, le plus grand BcMath\Number::scale des deux nombres utilisés pour la soustraction est utilisée.

C'est-à-dire que si les BcMath\Number::scale de deux valeurs sont `2` et `5` respectivement, le BcMath\Number::scale du résultat sera `5`.

### Erreurs / Exceptions

Cette méthode lève une ValueError dans les cas suivants :

- `num` est un string et n'est pas une chaîne numérique BCMath bien formée
- `scale` est en dehors de la plage valide

### Exemples

Exemple #1 Exemple de BcMath\Number::sub() lorsque `scale` n'est pas spécifié

`<?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);
?>`

L'exemple ci-dessus va afficher :

    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)
    }

Exemple #2 Exemple de BcMath\Number::sub() en spécifiant `scale` explicitement

`<?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);
?>`

L'exemple ci-dessus va afficher :

    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)
    }

### Voir aussi

- bcsub() - Soustrait un nombre de grande taille d'un autre
- BcMath\Number::add() - Ajouter un nombre de précision arbitraire