<!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>Raise an arbitrary precision number to another</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bcmul.html">bcmul</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bcpowmod.html">bcpowmod</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.bcpow" class="refentry">
<div class="refnamediv">
<h1 class="refname">bcpow</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">bcpow</span> — <span class="dc-title">Raise an arbitrary precision number to another</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.bcpow-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>bcpow</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>
] )</div>
<p class="para rdfs-comment">
Raise <em><code class="parameter">left_operand</code></em> to the power
<em><code class="parameter">right_operand</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.bcpow-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">left_operand</code></em></span>
<dd>
<p class="para">
The left operand, as a string.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">right_operand</code></em></span>
<dd>
<p class="para">
The right 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.bcpow-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the result as a string.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.bcpow-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-3393">
<p><strong>Example #1 <span class="function"><strong>bcpow()</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">bcpow</span><span style="color: #007700">(</span><span style="color: #DD0000">'4.2'</span><span style="color: #007700">, </span><span style="color: #DD0000">'3'</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">); </span><span style="color: #FF8000">// 74.08<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 notes" id="refsect1-function.bcpow-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
<span class="function"><strong>bcpow()</strong></span> may return a result with fewer digits after the
decimal point than the <em><code class="parameter">scale</code></em> parameter would
indicate. This only occurs when the result doesn't require all of the
precision allowed by the <em><code class="parameter">scale</code></em>. For example:
<div class="example" id="example-3394">
<p><strong>Example #2 <span class="function"><strong>bcpow()</strong></span> scale 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">echo </span><span style="color: #0000BB">bcpow</span><span style="color: #007700">(</span><span style="color: #DD0000">'5'</span><span style="color: #007700">, </span><span style="color: #DD0000">'2'</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">); </span><span style="color: #FF8000">// prints "25", not "25.00"<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.bcpow-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.bcpowmod.html" class="function" rel="rdfs-seeAlso">bcpowmod()</a> - Raise an arbitrary precision number to another, reduced by a specified modulus</span></li>
<li class="member"> <span class="function"><a href="function.bcsqrt.html" class="function" rel="rdfs-seeAlso">bcsqrt()</a> - Get the square root of an arbitrary precision number</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.bcmul.html">bcmul</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bcpowmod.html">bcpowmod</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>
