Sophie

Sophie

distrib > Mageia > 4 > i586 > by-pkgid > f800694edefe91adea2624f711a41a2d > files > 2140

php-manual-en-5.5.7-1.mga4.noarch.rpm

<!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 the square root 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.bcscale.html">bcscale</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.bcsub.html">bcsub</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.bcsqrt" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">bcsqrt</h1>
  <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">bcsqrt</span> &mdash; <span class="dc-title">Get the square root of an arbitrary precision number</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.bcsqrt-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="type">string</span> <span class="methodname"><strong>bcsqrt</strong></span>
    ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$operand</code></span>
   [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$scale</code></span>
  ] )</div>

  <p class="para rdfs-comment">
   Return the square root of the <em><code class="parameter">operand</code></em>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.bcsqrt-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>

    <dt>

     <span class="term"><em><code class="parameter">operand</code></em></span>
     <dd>

      <p class="para">
       The operand, as a string.
      </p>
     </dd>

    </dt>

    <dt>
<span class="term"><em><code class="parameter">
scale</code></em></span><dd>
<p class="para">This optional parameter is used to set the number
of digits after the decimal place in the result. You can also set the global default scale
for all functions by using  <span class="function"><a href="function.bcscale.html" class="function">bcscale()</a></span>.</p></dd>
</dt>

   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.bcsqrt-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns the square root as a string, or <strong><code>NULL</code></strong> if 
   <em><code class="parameter">operand</code></em> is negative. 
  </p>
 </div>

 
 <div class="refsect1 examples" id="refsect1-function.bcsqrt-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-3396">
   <p><strong>Example #1  <span class="function"><strong>bcsqrt()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #007700">echo&nbsp;</span><span style="color: #0000BB">bcsqrt</span><span style="color: #007700">(</span><span style="color: #DD0000">'2'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">3</span><span style="color: #007700">);&nbsp;</span><span style="color: #FF8000">//&nbsp;1.414<br /><br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
   </div>

  </div>
 </div>

 
 <div class="refsect1 seealso" id="refsect1-function.bcsqrt-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"> <span class="function"><a href="function.bcpow.html" class="function" rel="rdfs-seeAlso">bcpow()</a> - Raise an arbitrary precision number to another</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.bcscale.html">bcscale</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.bcsub.html">bcsub</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>