Devuelve el cociente y el módulo de un número de precisión arbitraria

# BcMath\Number::divmod

(PHP 8 >= 8.4.0)

BcMath\Number::divmod — Devuelve el cociente y el módulo de un número de precisión arbitraria

### Descripción

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

Devuelve el cociente y el módulo de la división de $this por `num`.

### Parámetros

`num`
  El divisor.
`scale`
  BcMath\Number::scale especificado explícitamente para los resultados del cálculo. Si `null`, el BcMath\Number::scale del resultado del cálculo será definido automáticamente.

### Valores devueltos

Devuelve un array indexado donde el primer elemento es el cociente en forma de un nuevo objeto BcMath\Number y el segundo elemento es el módulo en forma de un nuevo objeto BcMath\Number.

El cociente es siempre un valor entero, por lo que BcMath\Number::scale del cociente será siempre `0`, independientemente de si `scale` es explícitamente especificado.

Si `scale` es explícitamente especificado, BcMath\Number::scale del módulo será el valor especificado. Cuando el BcMath\Number::scale del objeto de módulo del resultado es definido automáticamente, el mayor BcMath\Number::scale de los dos números utilizados para la operación de módulo es utilizado.

Es decir, si los BcMath\Number::scales de dos valores son `2` y `5` respectivamente, el BcMath\Number::scale del módulo será `5`.

### Errores/Excepciones

Este método lanza una ValueError en los siguientes casos:

- `num` es un string y no es una cadena numérica BCMath bien formada
- `scale` está fuera del rango válido

Este método lanza una DivisionByZeroError si `num` es `0`.

### Ejemplos

Ejemplo #1 Ejemplo de BcMath\Number::divmod() cuando `scale` no es especificado

    <?php
    echo '8.3 / 2.22' . PHP_EOL;
    [$quot, $rem] = new BcMath\Number('8')->divmod(new BcMath\Number('2.22'));
    var_dump($quot, $rem);

    echo PHP_EOL . '8.3 / 8.3' . PHP_EOL;
    [$quot, $rem] = new BcMath\Number('8.3')->divmod('8.3');
    var_dump($quot, $rem);

    echo PHP_EOL . '10 / -3' . PHP_EOL;
    [$quot, $rem] = new BcMath\Number('10')->divmod(-3);
    var_dump($quot, $rem);
    ?>

El ejemplo anterior mostrará:

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

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

    10 / -3
    object(BcMath\Number)#3 (2) {
      ["value"]=>
      string(2) "-3"
      ["scale"]=>
      int(0)
    }
    object(BcMath\Number)#1 (2) {
      ["value"]=>
      string(1) "1"
      ["scale"]=>
      int(0)
    }

Ejemplo #2 Ejemplo de BcMath\Number::divmod() especificando `scale` explícitamente

    <?php
    echo '8.3 / 2.22' . PHP_EOL;
    [$quot, $rem] = new BcMath\Number('8')->divmod(new BcMath\Number('2.22'), 1);
    var_dump($quot, $rem);

    echo PHP_EOL . '8.3 / 8.3' . PHP_EOL;
    [$quot, $rem] = new BcMath\Number('8.3')->divmod('8.3', 4);
    var_dump($quot, $rem);

    echo PHP_EOL . '10 / -3' . PHP_EOL;
    [$quot, $rem] = new BcMath\Number('10')->divmod(-3, 5);
    var_dump($quot, $rem);
    ?>

El ejemplo anterior mostrará:

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

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

    10 / -3
    object(BcMath\Number)#3 (2) {
      ["value"]=>
      string(2) "-3"
      ["scale"]=>
      int(0)
    }
    object(BcMath\Number)#1 (2) {
      ["value"]=>
      string(7) "1.00000"
      ["scale"]=>
      int(5)
    }

### Ver también

- bcdivmod() - Devuelve el cociente y el resto de un número de precisión arbitraria
- BcMath\Number::div() - Divide por un número de precisión arbitraria
- BcMath\Number::mod() - Devuelve el módulo de un número de precisión arbitraria

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