Вычитает из числа произвольной точности

# BcMath\Number::sub

(PHP 8 >= 8.4.0)

BcMath\Number::sub — Вычитает из числа произвольной точности

### Описание

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

Метод вычитает число `num` из значения переменной $this.

### Список параметров

`num`
  Значение, которое требуется отнять.
`scale`
  Свойство BcMath\Number::scale явно указывает значение масштаба в результате расчёта. Со значением `null` для свойства BcMath\Number::scale метод автоматически установит масштаб в результате расчёта.

### Возвращаемые значения

Метод возвращает разницу в виде нового объекта BcMath\Number.

При автоустановке в объекте с результатом значения свойству BcMath\Number::scale метод устанавливает свойству наибольшее значение масштаба BcMath\Number::scale из двух чисел, которые участвуют в операции вычитания.

Поэтому когда значение свойства BcMath\Number::scale одного слагаемого равно `2`, а другого `5`, значение свойства BcMath\Number::scale в результате будет равняться `5`.

### Ошибки

Метод выбрасывает ошибку ValueError в следующих случаях:

- В аргументе `num` передали значение с типом string, которое сформировали неправильно с точки зрения допустимого формата числовых строк в модуле BCMath.
- Значение аргумента `scale` выходит за пределы допустимого диапазона.

### Примеры

Пример #1 Пример вычитания из числа произвольной точности методом BcMath\Number::sub() без указания значения для параметра `scale`

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

    ?>

Результат выполнения приведённого примера:

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

Пример #2 Пример вычитания из числа произвольной точности методом BcMath\Number::sub() с явным значением для параметра `scale`

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

    ?>

Результат выполнения приведённого примера:

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

### Смотрите также

- bcsub() - Вычитает одно число произвольной точности из другого
- BcMath\Number::add() - Складывает числа произвольной точности

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open