<!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>Square root with remainder</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gmp-sqrt.html">gmp_sqrt</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gmp-strval.html">gmp_strval</a></div>
<div class="up"><a href="ref.gmp.html">GMP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.gmp-sqrtrem" class="refentry">
<div class="refnamediv">
<h1 class="refname">gmp_sqrtrem</h1>
<p class="verinfo">(PHP 4 >= 4.0.4, PHP 5)</p><p class="refpurpose"><span class="refname">gmp_sqrtrem</span> — <span class="dc-title">Square root with remainder</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.gmp-sqrtrem-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>gmp_sqrtrem</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$a</code></span>
)</div>
<p class="para rdfs-comment">
Calculate the square root of a number, with remainder.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.gmp-sqrtrem-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">a</code></em></span>
<dd>
<p class="para">
The number being square rooted.
</p>
<p class="para">It can be either a GMP number <span class="type"><a href="language.types.resource.html" class="type resource">resource</a></span>, or a
numeric string given that it is possible to convert the latter to a number.</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gmp-sqrtrem-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns array where first element is the integer square root of
<em><code class="parameter">a</code></em> and the second is the remainder
(i.e., the difference between <em><code class="parameter">a</code></em> and the
first element squared).
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.gmp-sqrtrem-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3436">
<p><strong>Example #1 <span class="function"><strong>gmp_sqrtrem()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">list(</span><span style="color: #0000BB">$sqrt1</span><span style="color: #007700">, </span><span style="color: #0000BB">$sqrt1rem</span><span style="color: #007700">) = </span><span style="color: #0000BB">gmp_sqrtrem</span><span style="color: #007700">(</span><span style="color: #DD0000">"9"</span><span style="color: #007700">);<br />list(</span><span style="color: #0000BB">$sqrt2</span><span style="color: #007700">, </span><span style="color: #0000BB">$sqrt2rem</span><span style="color: #007700">) = </span><span style="color: #0000BB">gmp_sqrtrem</span><span style="color: #007700">(</span><span style="color: #DD0000">"7"</span><span style="color: #007700">);<br />list(</span><span style="color: #0000BB">$sqrt3</span><span style="color: #007700">, </span><span style="color: #0000BB">$sqrt3rem</span><span style="color: #007700">) = </span><span style="color: #0000BB">gmp_sqrtrem</span><span style="color: #007700">(</span><span style="color: #DD0000">"1048576"</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">gmp_strval</span><span style="color: #007700">(</span><span style="color: #0000BB">$sqrt1</span><span style="color: #007700">) . </span><span style="color: #DD0000">", " </span><span style="color: #007700">. </span><span style="color: #0000BB">gmp_strval</span><span style="color: #007700">(</span><span style="color: #0000BB">$sqrt1rem</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">gmp_strval</span><span style="color: #007700">(</span><span style="color: #0000BB">$sqrt2</span><span style="color: #007700">) . </span><span style="color: #DD0000">", " </span><span style="color: #007700">. </span><span style="color: #0000BB">gmp_strval</span><span style="color: #007700">(</span><span style="color: #0000BB">$sqrt2rem</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">gmp_strval</span><span style="color: #007700">(</span><span style="color: #0000BB">$sqrt3</span><span style="color: #007700">) . </span><span style="color: #DD0000">", " </span><span style="color: #007700">. </span><span style="color: #0000BB">gmp_strval</span><span style="color: #007700">(</span><span style="color: #0000BB">$sqrt3rem</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
3, 0
2, 3
1024, 0
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gmp-sqrt.html">gmp_sqrt</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gmp-strval.html">gmp_strval</a></div>
<div class="up"><a href="ref.gmp.html">GMP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
