Умножает число произвольной точности

# BcMath\Number::mul

(PHP 8 >= 8.4.0)

BcMath\Number::mul — Умножает число произвольной точности

### Описание

public function BcMath\Number::mul(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 в произведении будет равняться `7`, если значение свойства BcMath\Number::scale одного операнда равняется `2`, а другого `5`.

### Ошибки

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

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

### Примеры

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

    <?php

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

    $ret1 = $number->mul(new BcMath\Number('2.3456'));
    $ret2 = $number->mul('-3.4');
    $ret3 = $number->mul(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(9) "2.8944704"
      ["scale"]=>
      int(7)
    }
    object(BcMath\Number)#2 (2) {
      ["value"]=>
      string(7) "-4.1956"
      ["scale"]=>
      int(4)
    }
    object(BcMath\Number)#4 (2) {
      ["value"]=>
      string(5) "8.638"
      ["scale"]=>
      int(3)
    }

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

    <?php

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

    $ret1 = $number->mul(new BcMath\Number('2.3456'), 1);
    $ret2 = $number->mul('-3.4', 10);
    $ret3 = $number->mul(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(3) "2.8"
      ["scale"]=>
      int(1)
    }
    object(BcMath\Number)#2 (2) {
      ["value"]=>
      string(13) "-4.1956000000"
      ["scale"]=>
      int(10)
    }
    object(BcMath\Number)#4 (2) {
      ["value"]=>
      string(1) "8"
      ["scale"]=>
      int(0)
    }

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

- bcmul() - Умножает два числа произвольной точности
- BcMath\Number::div() - Делит числа произвольной точности
- BcMath\Number::pow() - Возводит число произвольной точности в степень
- BcMath\Number::powmod() - Возводит число произвольной точности в степень и делит результат возведения в степень на модуль числа

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