任意精度数値の剰余を取得する

# 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` で割った剰余を取得します。 `num` が `0` でない限り、 結果は $this と同じ符号になります。

### パラメータ

`num`
  除数を表す値。
`scale`
  計算結果オブジェクトの BcMath\Number::scale を明示的に指定します。 `null` の場合、計算結果の BcMath\Number::scale は自動的に設定されます。

### 戻り値

剰余オブジェクトを新しい BcMath\Number オブジェクトとして返します。

剰余オブジェクトの BcMath\Number::scale が自動的に設定される場合、剰余計算に使用する2つの数値のうち、 大きい方の BcMath\Number::scale が使用されます。

つまり、2つの値の BcMath\Number::scale がそれぞれ `2` と `5` の場合、 加算結果オブジェクトの BcMath\Number::scale は `5` になります。

### エラー / 例外

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

- `num` が、BCMath で有効でない数値形式の文字列である場合
- `scale` が範囲外の値である場合

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

### 例

例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() - 2 つの任意精度数値の剰余を取得する
- BcMath\Number::div() - 任意精度数値の除算を行う
- BcMath\Number::divmod() - 任意精度数値の商と剰余を取得する
- BcMath\Number::powmod() - 任意精度数値のべき乗の、指定した数値による剰余

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