bcmod

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

説明

string bcmod(string $num1, string $num2, intnull $scale = null)

num1 の、 num2 を法とする剰余を取得します。 結果は num1 と同じ符号を持ちます。

パラメータ

num1

左オペランドを表す文字列。

num2

右オペランドを表す文字列。

scale
結果の小数点以下の桁数を指定します。null の場合は、 bcscale 関数でグローバルに 設定した桁数をデフォルトとして使用します。 それも設定されていない場合は bcmath.scale INI ディレクティブの値を使用します。

戻り値

剰余を文字列で返します。 num2 が 0 の場合は null を返します。

エラー / 例外

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

  • num1 もしくは num1 が、BCMath で有効でない数値形式の文字列である場合
  • scale が範囲外の値である場合

この関数は、 num20 である場合、 DivisionByZeroError 例外をスローします。

変更履歴

バージョン 説明
8.0.0 scale は nullable になりました。
8.0.0 0 除算を行うと、DivisionByZeroError 例外がスローされるようになりました。以前は null が返されていました。
7.2.0 num1num2 は 整数に切り詰められることがなくなりました。 よって、bcmod の振る舞いは % 演算子ではなく、 fmod に従うことになります。
7.2.0 scale パラメータが追加されました。

例1 bcmod の例

<?php
bcscale(0);
echo bcmod( '5',  '3'); //  2
echo bcmod( '5', '-3'); //  2
echo bcmod('-5',  '3'); // -2
echo bcmod('-5', '-3'); // -2
?>

例2 bcmod に小数の値を指定する

<?php
bcscale(1);
echo bcmod('5.7', '1.3'); // 0.5 as of PHP 7.2.0; 0 previously
?>

参考

  • bcdiv
  • BcMath\Number::mod