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

# BcMath\Number::div

(PHP 8 >= 8.4.0)

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

### Описание

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

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

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

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

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

Метод возвращает результат деления как новый объект BcMath\Number.

При автоустановке в объекте с результатом значения свойству BcMath\Number::scale метод устанавливает свойству значение масштаба BcMath\Number::scale делимого, но при невозможности деления расширяет значение свойства BcMath\Number::scale в объекте с результатом. Метод расширяет масштаб только когда требуется и не больше чем на `+10` знаков.

Метод установит значение масштаба BcMath\Number::scale в результате между `5` и `15`, если значение свойства BcMath\Number::scale в делимом равняется `5`.

Даже в неделимых вычислениях значение свойства BcMath\Number::scale расширяется на `+10` знаков не в каждой операции. Метод считает, что `0` в конце результата не требует расширения, поэтому масштаб BcMath\Number::scale уменьшается до этой величины. Значение свойства BcMath\Number::scale никогда не будет меньше, чем масштаб BcMath\Number::scale перед расширением. Смотрите также пример кода.

### Ошибки

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

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

Метод выбрасывает ошибку DivisionByZeroError, если значение аргумента `num` равняется `0`.

### Примеры

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

    <?php

    $number = new BcMath\Number('0.002');

    $ret1 = $number->div(new BcMath\Number('2.000'));
    $ret2 = $number->div('-3');
    $ret3 = $number->div(32);

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

    ?>

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

    object(BcMath\Number)#1 (2) {
      ["value"]=>
      string(5) "0.002"
      ["scale"]=>
      int(3)
    }
    object(BcMath\Number)#3 (2) {
      ["value"]=>
      string(5) "0.001"
      ["scale"]=>
      int(3)
    }
    object(BcMath\Number)#2 (2) {
      ["value"]=>
      string(16) "-0.0006666666666"
      ["scale"]=>
      int(13)
    }
    object(BcMath\Number)#4 (2) {
      ["value"]=>
      string(9) "0.0000625"
      ["scale"]=>
      int(7)
    }

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

    <?php

    $number = new BcMath\Number('0.002');

    $ret1 = $number->div(new BcMath\Number('2.000'), 15);
    $ret2 = $number->div('-3', 5);
    $ret3 = $number->div(32, 2);

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

    ?>

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

    object(BcMath\Number)#1 (2) {
      ["value"]=>
      string(5) "0.002"
      ["scale"]=>
      int(3)
    }
    object(BcMath\Number)#3 (2) {
      ["value"]=>
      string(17) "0.001000000000000"
      ["scale"]=>
      int(15)
    }
    object(BcMath\Number)#2 (2) {
      ["value"]=>
      string(8) "-0.00066"
      ["scale"]=>
      int(5)
    }
    object(BcMath\Number)#4 (2) {
      ["value"]=>
      string(4) "0.00"
      ["scale"]=>
      int(2)
    }

Пример #3 Пример расширения масштаба BcMath\Number::scale в объекте с результатом при делении чисел произвольной точности методом BcMath\Number::div()

    <?php

    var_dump(
        new BcMath\Number('0.001')->div('10001'),
        new BcMath\Number('0.001')->div('10001', 13),
        new BcMath\Number('0.001')->div('100000000000001'),
    );

    ?>

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

    object(BcMath\Number)#2 (2) {
      ["value"]=>
      string(13) "0.00000009999"
      ["scale"]=>
      int(11)
    }
    object(BcMath\Number)#3 (2) {
      ["value"]=>
      string(15) "0.0000000999900"
      ["scale"]=>
      int(13)
    }
    object(BcMath\Number)#4 (2) {
      ["value"]=>
      string(5) "0.000"
      ["scale"]=>
      int(3)
    }

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

- bcdiv() - Делит два числа произвольной точности
- BcMath\Number::divmod() - Получает неполное частное и остаток от деления числа произвольной точности
- BcMath\Number::mod() - Получает остаток от деления числа произвольной точности
- BcMath\Number::sqrt() - Извлекает квадратный корень из числа произвольной точности
- BcMath\Number::pow() - Возводит число произвольной точности в степень
- BcMath\Number::mul() - Умножает число произвольной точности

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