BcMath\Number::pow

(PHP 8 >= 8.4.0)

BcMath\Number::pow — 任意精度数値をべき乗する

説明

public BcMath\Number::pow(BcMath\Number|string|int $exponent, ?int $scale = null): BcMath\Number

$this の exponent 乗を求めます。

パラメータ

exponent: 指数を表す値。整数値でなければなりません。 exponent の有効な範囲はプラットフォームに依存しますが、少なくとも -2147483648 から 2147483647 までの範囲を持ちます。
scale: 計算結果オブジェクトの BcMath\Number::scale を明示的に指定します。 null の場合、計算結果の BcMath\Number::scale は自動的に設定されます。

戻り値

べき乗の結果を新しい BcMath\Number オブジェクトとして返します。

べき乗結果オブジェクトの BcMath\Number::scale が自動的に設定される場合、 exponent の値に応じて、結果の BcMath\Number::scale が以下のようになります:

exponent べき乗結果オブジェクトの BcMath\Number::scale

正の値 (基数の BcMath\Number::scale) * (exponent の値)

0 0

負の値 (基数の BcMath\Number::scale) と (基数の BcMath\Number::scale + 10) の間

`exponent`	べき乗結果オブジェクトの BcMath\Number::scale
正の値	(基数の BcMath\Number::scale) * (`exponent` の値)
`0`	`0`
負の値	(基数の BcMath\Number::scale) と (基数の BcMath\Number::scale + `10`) の間

負の exponent を指定し割り切れない除算が発生した場合、べき乗結果オブジェクトの BcMath\Number::scale が拡張されます。拡張は必要な場合にのみ行われ、最大で +10 まで拡張されます。この動作は BcMath\Number::div() と同じですので、詳しくはそちらを参照して下さい。

エラー / 例外

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

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

このメソッドは、$this の値が 0 かつ exponent が負の値である場合、 DivisionByZeroError 例外をスローします。

例

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

<?php
$number = new BcMath\Number('3.0');

$ret1 = $number->pow(new BcMath\Number('5'));
$ret2 = $number->pow('-1');
$ret3 = $number->pow(0);

var_dump($number, $ret1, $ret2, $ret3);
?>

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

object(BcMath\Number)#1 (2) {
  ["value"]=>
  string(3) "3.0"
  ["scale"]=>
  int(1)
}
object(BcMath\Number)#3 (2) {
  ["value"]=>
  string(9) "243.00000"
  ["scale"]=>
  int(5)
}
object(BcMath\Number)#2 (2) {
  ["value"]=>
  string(13) "0.33333333333"
  ["scale"]=>
  int(11)
}
object(BcMath\Number)#4 (2) {
  ["value"]=>
  string(1) "1"
  ["scale"]=>
  int(0)
}

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

<?php
$number = new BcMath\Number('3.0');

$ret1 = $number->pow(new BcMath\Number('5'), 0);
$ret2 = $number->pow('-1', 2);
$ret3 = $number->pow(0, 10);

var_dump($number, $ret1, $ret2, $ret3);
?>

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

object(BcMath\Number)#1 (2) {
  ["value"]=>
  string(3) "3.0"
  ["scale"]=>
  int(1)
}
object(BcMath\Number)#3 (2) {
  ["value"]=>
  string(3) "243"
  ["scale"]=>
  int(0)
}
object(BcMath\Number)#2 (2) {
  ["value"]=>
  string(4) "0.33"
  ["scale"]=>
  int(2)
}
object(BcMath\Number)#4 (2) {
  ["value"]=>
  string(12) "1.0000000000"
  ["scale"]=>
  int(10)
}

参考

bcpow() - 任意精度数値をべき乗する
BcMath\Number::powmod() - 任意精度数値のべき乗の、指定した数値による剰余
BcMath\Number::mul() - 任意精度数値の乗算を行う
BcMath\Number::sqrt() - 任意精度数値の平方根を取得する
BcMath\Number::div() - 任意精度数値の除算を行う