<!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>Tests if a bit is set</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gmp-sub.html">gmp_sub</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gmp-xor.html">gmp_xor</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-testbit" class="refentry">
<div class="refnamediv">
<h1 class="refname">gmp_testbit</h1>
<p class="verinfo">(PHP 5 >= 5.3.0)</p><p class="refpurpose"><span class="refname">gmp_testbit</span> — <span class="dc-title">Tests if a bit is set</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.gmp-testbit-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>gmp_testbit</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$a</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></span>
)</div>
<p class="para rdfs-comment">
Tests if the specified bit is set.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.gmp-testbit-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">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>
<dt>
<span class="term"><em><code class="parameter">index</code></em></span>
<dd>
<p class="para">
The bit to test
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gmp-testbit-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if the bit is set in resource <em><code class="parameter">$a</code></em>,
otherwise <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 errors" id="refsect1-function.gmp-testbit-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
An <strong><code>E_WARNING</code></strong> level error is issued when
<em><code class="parameter">index</code></em> is less than zero, and <strong><code>FALSE</code></strong>
is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.gmp-testbit-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3439">
<p><strong>Example #1 <span class="function"><strong>gmp_testbit()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$n </span><span style="color: #007700">= </span><span style="color: #0000BB">gmp_init</span><span style="color: #007700">(</span><span style="color: #DD0000">"1000000"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">gmp_testbit</span><span style="color: #007700">(</span><span style="color: #0000BB">$n</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">gmp_setbit</span><span style="color: #007700">(</span><span style="color: #0000BB">$n</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">gmp_testbit</span><span style="color: #007700">(</span><span style="color: #0000BB">$n</span><span style="color: #007700">, </span><span style="color: #0000BB">1</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>
bool(false)
bool(true)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.gmp-testbit-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.gmp-setbit.html" class="function" rel="rdfs-seeAlso">gmp_setbit()</a> - Set bit</span></li>
<li class="member"> <span class="function"><a href="function.gmp-clrbit.html" class="function" rel="rdfs-seeAlso">gmp_clrbit()</a> - Clear bit</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.gmp-sub.html">gmp_sub</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gmp-xor.html">gmp_xor</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>
