Получает остаток от деления числа произвольной точности

# BcMath\Number::mod

(PHP 8 >= 8.4.0)

BcMath\Number::mod — Получает остаток от деления числа произвольной точности

### Описание

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

Метод получает остаток от деления значения переменной $this на число `num`. Знак числа в результате будет таким же, как у значения переменной $this, если только число `num` не равняется `0`.

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

`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` выходит за пределы допустимого диапазона.

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

### Примеры

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

    <?php

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

    $ret1 = $number->mod(new BcMath\Number('2.22'));
    $ret2 = $number->mod('8.3');
    $ret3 = $number->mod(-5);

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

    ?>

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

    object(BcMath\Number)#1 (2) {
      ["value"]=>
      string(3) "8.3"
      ["scale"]=>
      int(1)
    }
    object(BcMath\Number)#3 (2) {
      ["value"]=>
      string(4) "1.64"
      ["scale"]=>
      int(2)
    }
    object(BcMath\Number)#2 (2) {
      ["value"]=>
      string(3) "0.0"
      ["scale"]=>
      int(1)
    }
    object(BcMath\Number)#4 (2) {
      ["value"]=>
      string(3) "3.3"
      ["scale"]=>
      int(1)
    }

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

    <?php

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

    $ret1 = $number->mod(new BcMath\Number('2.22'), 1);
    $ret2 = $number->mod('8.3', 3);
    $ret3 = $number->mod(-5, 0);

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

    ?>

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

    object(BcMath\Number)#1 (2) {
      ["value"]=>
      string(3) "8.3"
      ["scale"]=>
      int(1)
    }
    object(BcMath\Number)#3 (2) {
      ["value"]=>
      string(3) "1.6"
      ["scale"]=>
      int(1)
    }
    object(BcMath\Number)#2 (2) {
      ["value"]=>
      string(5) "0.000"
      ["scale"]=>
      int(3)
    }
    object(BcMath\Number)#4 (2) {
      ["value"]=>
      string(1) "3"
      ["scale"]=>
      int(0)
    }

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

- bcmod() - Получает остаток от деления чисел произвольной точности
- BcMath\Number::div() - Делит числа произвольной точности
- BcMath\Number::divmod() - Получает неполное частное и остаток от деления числа произвольной точности
- BcMath\Number::powmod() - Возводит число произвольной точности в степень и делит результат возведения в степень на модуль числа

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