PHP 8.4.2 Released!

    bcmod

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

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

    説明

    bcmod(string $num1, string $num2, ?int $scale = null): string

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

    パラメータ

    num1

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

    num2

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

    scale
    This parameter is used to set the number of digits after the decimal place in the result. If null, it will default to the default scale set with bcscale(), or fallback to the value of the bcmath.scale INI directive.

    戻り値

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

    エラー / 例外

    This function throws a ValueError in the following cases:

    • num1 or num2 is not a well-formed BCMath numeric string.
    • scale is outside the valid range.

    This function throws a DivisionByZeroError exception if num2 is 0.

    変更履歴

    バージョン 説明
    8.0.0 scale は nullable になりました。
    8.0.0 Dividing by 0 now throws a DivisionByZeroError exception instead of returning null.
    7.2.0 num1 と num2 は 整数に切り詰められることがなくなりました。 よって、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() - 2つの任意精度数値で除算を行う

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    5
    lauris at night dot lt
    20 years ago
    <?php
    /**
    * my_bcmod - get modulus (substitute for bcmod)
    * string my_bcmod ( string left_operand, int modulus )
    * left_operand can be really big, but be carefull with modulus :(
    * by Andrius Baranauskas and Laurynas Butkus :) Vilnius, Lithuania
    **/
    function my_bcmod( $x, $y )
    {
    // how many numbers to take at once? carefull not to exceed (int)
    $take = 5;
    $mod = '';

    do
    {
    $a = (int)$mod.substr( $x, 0, $take );
    $x = substr( $x, $take );
    $mod = $a % $y;
    }
    while (     strlen($x) );

    return (int)    $mod;
    }

    // example
    echo my_bcmod( "7044060001970316212900", 150 );
    ?>
    up
    1
    drahoszdenek at gmail dot com
    11 years ago
    The modulus can be only integer. For "floats" bcmod returns 0:

    <?php
    echo bcmod('10', '2.1'); // 0
    ?>

    For real modulus you can use BN-PHP project (hosted at Bitbucket):

    <?php
    $eval     = new \BN\Expression\ExpressionEvaluator();
    $operators = new \BN\Expression\OperatorsFactory();
    $eval->setOperators($operators->getOperators(array('%')));

    echo     $eval->evaluate('10 % 2.1'); // 1.6
    echo $eval->evaluate('10 % -2.1'); // 1.6
    echo $eval->evaluate('-10 % 2.1'); // -1.6
    echo $eval->evaluate('-10 % -2.1'); // -1.6
    ?>
    ＋add a note
    To Top