bcsub

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

    bcsub — 任意精度数値の減算を行う

    説明

    bcsub(string $left_operand, string $right_operand, int $scale = 0): string

    left_operand から right_operand を引きます。

    パラメータ

    num1

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

    num2

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

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

    戻り値

    減算の結果を文字列で返します。

    エラー / 例外

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

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

    変更履歴

    バージョン 説明
    8.0.0 scale は nullable になりました。

    例

    例1 bcsub() の例

    <?php

    $a     = '1.234';
    $b = '5';

    echo     bcsub($a, $b); // -3
    echo bcsub($a, $b, 4); // -3.7660

    ?>

    参考

    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
    7
    nd at snackbox dot org
    6 years ago
    The parameter order here is probably fairly obvious to most people (subtract right from left), but to clarify with a simple use case since I was struggling with this at the end of a long day:

    <?php
    echo bcsub('7', '5'); // 7 - 5 = '2'
    echo bcsub('12', '17'); // 12 - 17 = '-5'
    ?>

    Provide the parameters in the same order you would when using a normal subtraction operator.
    up
    0
    charles dot adrian dot wood at gmail dot com
    5 years ago
    Please note that bcsub will fail in non-obvious ways if it's fed something that cannot be converted to a number. For instance:

    bcsub('yes', 'no') === '0'

    Yes, if you put garbage in, you get garbage out. Just don't expect bcsub to throw an error when you feed it an entirely non-numeric value.
    ＋add a note
    To Top