任意精度数値のべき乗の、指定した数値による剰余

# BcMath\Number::powmod

(PHP 8 >= 8.4.0)

BcMath\Number::powmod — 任意精度数値のべき乗の、指定した数値による剰余

### 説明

public function BcMath\Number::powmod(BcMath\Number|string|int `$exponent`, BcMath\Number|string|int `$modulus`, ?int `$scale` = `null`): BcMath\Number

`modulus` で割った余りを求めることを考慮して、 $this の `exponent` 乗を高速に計算します。

### パラメータ

`exponent`
  基数を表す整数の値。 (つまり、scale は 0 でなければいけません)
`modulus`
  指数を表す、負でない、整数の値。 (つまり、scale は 0 でなければいけません)
`scale`
  計算結果オブジェクトの BcMath\Number::scale を明示的に指定します。 `null` の場合、計算結果の BcMath\Number::scale は自動的に設定されます。

### 戻り値

計算結果を新しい BcMath\Number オブジェクトとして返します。

計算結果オブジェクトの BcMath\Number::scale が自動的に設定される場合、常に `0` になります。

### エラー / 例外

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

- `exponent` もしくは `modulus` が、BCMath で有効でない数値形式の文字列である場合
- $this か `exponent` か `modulus` のうち、どれか一つでも整数値でない場合
- `exponent` が負の値である場合
- `scale` が範囲外の値である場合

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

### 例

例1 BcMath\Number::powmod() で `scale` を指定しない例

    <?php
    var_dump(
        new BcMath\Number('8')->powmod(new BcMath\Number('3'), 5),
        new BcMath\Number('-8')->powmod(new BcMath\Number('3'), 5),
        new BcMath\Number('8')->powmod('2', -3),
        new BcMath\Number('-8')->powmod(5, 7),
    );
    ?>

上の例の出力は以下となります。

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

例2 BcMath\Number::powmod() で `scale` を指定する例

    <?php
    var_dump(
        new BcMath\Number('8')->powmod(new BcMath\Number('3'), 5, 1),
        new BcMath\Number('-8')->powmod(new BcMath\Number('3'), 5, 2),
        new BcMath\Number('8')->powmod('2', -3, 3),
        new BcMath\Number('-8')->powmod(5, 7, 4),
    );
    ?>

上の例の出力は以下となります。

    object(BcMath\Number)#3 (2) {
      ["value"]=>
      string(3) "2.0"
      ["scale"]=>
      int(1)
    }
    object(BcMath\Number)#4 (2) {
      ["value"]=>
      string(5) "-2.00"
      ["scale"]=>
      int(2)
    }
    object(BcMath\Number)#2 (2) {
      ["value"]=>
      string(5) "1.000"
      ["scale"]=>
      int(3)
    }
    object(BcMath\Number)#5 (2) {
      ["value"]=>
      string(7) "-1.0000"
      ["scale"]=>
      int(4)
    }

### 参考

- bcpowmod() - 任意精度数値のべき乗の、指定した数値による剰余
- BcMath\Number::pow() - 任意精度数値をべき乗する
- BcMath\Number::mod() - 任意精度数値の剰余を取得する

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