bcsub

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

bcsub — Вычитает одно число произвольной точности из другого

Описание

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

Функция вычитает число num2 из числа num1.

Список параметров

num1: Левый операнд (слагаемое) в виде строки.
num2: Правый операнд (слагаемое) в виде строки.
scale: Параметр используется для установки количества цифр после десятичного знака в результате. Если установлено значение null, то по умолчанию будет установлен масштаб по умолчанию, заданный с помощью функции bcscale() или значение INI-директивы bcmath.scale.

Возвращаемые значения

Функция возвращает разность в виде строки.

Ошибки

Функция выбрасывает исключение ValueError в следующих случаях:

Значение аргумента num1 или num2 оказалось строкой, которую сформировали неправильно с точки зрения допустимого формата числовых строк в модуле BCMath.
Значение аргумента scale выходит за пределы допустимого диапазона.

Список изменений

Версия	Описание
8.0.0	Параметр `scale` теперь принимает значение `null`.

Примеры

Пример #1 Пример вычитания чисел произвольной точности функцией bcsub()

<?php

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

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

?>

Смотрите также

bcadd() - Складывает два числа произвольной точности
BcMath\Number::sub() - Вычитает из числа произвольной точности

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей 2 notes

down

nd at snackbox dot org ¶

8 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.

down

charles dot adrian dot wood at gmail dot com ¶

7 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.

＋Добавить