<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Subtract one arbitrary precision number from another</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bcsqrt.html">bcsqrt</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.gmp.html">GMP</a></div>
<div class="up"><a href="ref.bc.html">BC Math Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.bcsub" class="refentry">
<div class="refnamediv">
<h1 class="refname">bcsub</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">bcsub</span> — <span class="dc-title">Subtract one arbitrary precision number from another</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.bcsub-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>bcsub</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$left_operand</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$right_operand</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$scale</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
Subtracts the <code class="parameter">right_operand</code> from the
<code class="parameter">left_operand</code>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.bcsub-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">left_operand</code></dt>
<dd>
<p class="para">
The left operand, as a string.
</p>
</dd>
<dt>
<code class="parameter">right_operand</code></dt>
<dd>
<p class="para">
The right operand, as a string.
</p>
</dd>
<dt>
<code class="parameter">
scale</code></dt>
<dd>
<p class="para">This optional parameter is used to set the number
of digits after the decimal place in the result. If omitted, it will default to the scale set
globally with the <span class="function"><a href="function.bcscale.html" class="function">bcscale()</a></span> function, or fallback to <em>0</em> if
this has not been set.</p></dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.bcsub-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The result of the subtraction, as a string.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.bcsub-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4188">
<p><strong>Example #1 <span class="function"><strong>bcsub()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$a </span><span style="color: #007700">= </span><span style="color: #DD0000">'1.234'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$b </span><span style="color: #007700">= </span><span style="color: #DD0000">'5'</span><span style="color: #007700">;<br /><br />echo </span><span style="color: #0000BB">bcsub</span><span style="color: #007700">(</span><span style="color: #0000BB">$a</span><span style="color: #007700">, </span><span style="color: #0000BB">$b</span><span style="color: #007700">); </span><span style="color: #FF8000">// -3<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">bcsub</span><span style="color: #007700">(</span><span style="color: #0000BB">$a</span><span style="color: #007700">, </span><span style="color: #0000BB">$b</span><span style="color: #007700">, </span><span style="color: #0000BB">4</span><span style="color: #007700">); </span><span style="color: #FF8000">// -3.7660<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-function.bcsub-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.bcadd.html" class="function" rel="rdfs-seeAlso">bcadd()</a> - Add two arbitrary precision numbers</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bcsqrt.html">bcsqrt</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.gmp.html">GMP</a></div>
<div class="up"><a href="ref.bc.html">BC Math Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
