<!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>Compare two arbitrary precision numbers</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bcadd.html">bcadd</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bcdiv.html">bcdiv</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.bccomp" class="refentry">
<div class="refnamediv">
<h1 class="refname">bccomp</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">bccomp</span> — <span class="dc-title">Compare two arbitrary precision numbers</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.bccomp-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>bccomp</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">
Compares the <code class="parameter">left_operand</code> to the
<code class="parameter">right_operand</code> and returns the result as an
integer.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.bccomp-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">
The optional <code class="parameter">scale</code> parameter is used to set the
number of digits after the decimal place which will be used in the
comparison.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.bccomp-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns 0 if the two operands are equal, 1 if the
<code class="parameter">left_operand</code> is larger than the
<code class="parameter">right_operand</code>, -1 otherwise.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.bccomp-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4178">
<p><strong>Example #1 <span class="function"><strong>bccomp()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">bccomp</span><span style="color: #007700">(</span><span style="color: #DD0000">'1'</span><span style="color: #007700">, </span><span style="color: #DD0000">'2'</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">; </span><span style="color: #FF8000">// -1<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">bccomp</span><span style="color: #007700">(</span><span style="color: #DD0000">'1.00001'</span><span style="color: #007700">, </span><span style="color: #DD0000">'1'</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">); </span><span style="color: #FF8000">// 0<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">bccomp</span><span style="color: #007700">(</span><span style="color: #DD0000">'1.00001'</span><span style="color: #007700">, </span><span style="color: #DD0000">'1'</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">); </span><span style="color: #FF8000">// 1<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bcadd.html">bcadd</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bcdiv.html">bcdiv</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>
