bcsqrt

(PHP 4, PHP 5, PHP 7, PHP 8)

bcsqrt任意精度数値の平方根を取得する

説明

bcsqrt(string $num, ?int $scale = null): string

num の平方根を返します。

パラメータ

num

オペランドを表す、BCMath で有効な数値形式の文字列。

scale

このオプションパラメータを使用して、結果の小数点以下の桁数を指定します。省略した場合は、bcscale() 関数でグローバルに設定した桁数をデフォルトとして使用します。それも設定されていない場合は 0 を使用します。

戻り値

平方根を、BCMath で有効な数値形式の文字列で返します。

エラー / 例外

この関数は、以下の場合に ValueError をスローします:

  • num が、BCMath で有効でない数値形式の文字列である場合
  • num0 より小さい場合
  • scale が範囲外の値である場合

変更履歴

バージョン 説明
8.0.0 num が BCMath で有効でない数値形式の文字列だったり、 0 より小さい場合、 ValueError がスローされるようになりました。 これより前のバージョンでは、E_WARNING が発生していました。
8.0.0 scale02147483647 の間にあることが必須になりました。 これより前のバージョンでは、負の値は黙って 0 として扱われていました。
8.0.0 scale は、nullable になりました。

例1 bcsqrt() の例

<?php

echo bcsqrt('2', 3); // 1.414

?>

参考

  • bcpow() - 任意精度数値をべき乗する