任意精度数値の除算を行う

# 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` の場合、 除算結果オブジェクトの BcMath\Number::scale は `5` から `15` の間になります。

割り切れない除算の場合でも、除算結果オブジェクトの BcMath\Number::scale は常に `+10` まで拡張されるわけではありません。 末尾が `0` である場合は拡張の必要がないと見なされるため、 BcMath\Number::scale はその分だけ少なくなります。 また、最終的な BcMath\Number::scale は、拡張前の BcMath\Number::scale よりも小さくなることはありません。 コード例 も参照してください。

### エラー / 例外

このメソッドは、以下の場合に ValueError をスローします:

- `num` が、BCMath で有効でない数値形式の文字列である場合
- `scale` が範囲外の値である場合
- 結果オブジェクトの BcMath\Number::scale が範囲外の値である場合

このメソッドは、 `num` が `0` である場合、 DivisionByZeroError 例外をスローします。

### 例

例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::div() の結果の BcMath\Number::scale が拡張される例

    <?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() - 2つの任意精度数値で除算を行う
- 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