<!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>Get modulus of an arbitrary precision number</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bcdiv.html">bcdiv</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bcmul.html">bcmul</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.bcmod" class="refentry">
<div class="refnamediv">
<h1 class="refname">bcmod</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">bcmod</span> — <span class="dc-title">Get modulus of an arbitrary precision number</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.bcmod-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>bcmod</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$dividend</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$divisor</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$scale</code></span>
] )</div>
<p class="para rdfs-comment">
Get the remainder of dividing <code class="parameter">dividend</code> by
<code class="parameter">divisor</code>.
Unless <code class="parameter">divisor</code> is zero, the result has the same sign
as <code class="parameter">dividend</code>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.bcmod-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">dividend</code></dt>
<dd>
<p class="para">
The dividend, as a string.
</p>
</dd>
<dt>
<code class="parameter">divisor</code></dt>
<dd>
<p class="para">
The divisor, as a string.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.bcmod-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the modulus as a string, or <strong><code>NULL</code></strong> if
<code class="parameter">divisor</code> is <em>0</em>.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.bcmod-changelog">
<h3 class="title">Changelog</h3>
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>7.2.0</td>
<td>
<code class="parameter">dividend</code> and <code class="parameter">divisor</code> are no
longer truncated to integer, so now the behavior of
<span class="function"><strong>bcmod()</strong></span> follows <span class="function"><a href="function.fmod.html" class="function">fmod()</a></span> rather than
the <em>%</em> operator.
</td>
</tr>
<tr>
<td>7.2.0</td>
<td>
The <code class="parameter">scale</code> parameter was added.
</td>
</tr>
</tbody>
</table>
</div>
<div class="refsect1 examples" id="refsect1-function.bcmod-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4180">
<p><strong>Example #1 <span class="function"><strong>bcmod()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />bcscale</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">bcmod</span><span style="color: #007700">( </span><span style="color: #DD0000">'5'</span><span style="color: #007700">, </span><span style="color: #DD0000">'3'</span><span style="color: #007700">); </span><span style="color: #FF8000">// 2<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">bcmod</span><span style="color: #007700">( </span><span style="color: #DD0000">'5'</span><span style="color: #007700">, </span><span style="color: #DD0000">'-3'</span><span style="color: #007700">); </span><span style="color: #FF8000">// 2<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">bcmod</span><span style="color: #007700">(</span><span style="color: #DD0000">'-5'</span><span style="color: #007700">, </span><span style="color: #DD0000">'3'</span><span style="color: #007700">); </span><span style="color: #FF8000">// -2<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">bcmod</span><span style="color: #007700">(</span><span style="color: #DD0000">'-5'</span><span style="color: #007700">, </span><span style="color: #DD0000">'-3'</span><span style="color: #007700">); </span><span style="color: #FF8000">// -2<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-4181">
<p><strong>Example #2 <span class="function"><strong>bcmod()</strong></span> with decimals</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />bcscale</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">bcmod</span><span style="color: #007700">(</span><span style="color: #DD0000">'5.7'</span><span style="color: #007700">, </span><span style="color: #DD0000">'1.3'</span><span style="color: #007700">); </span><span style="color: #FF8000">// 0.5 as of PHP 7.2.0; 0 previously<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-function.bcmod-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.bcdiv.html" class="function" rel="rdfs-seeAlso">bcdiv()</a> - Divide 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.bcdiv.html">bcdiv</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bcmul.html">bcmul</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>
