gmp-clrbit.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.gmp-clrbit" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gmp_clrbit</refname>
  <refpurpose>Clear bit</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>gmp_clrbit</methodname>
   <methodparam><type>GMP</type><parameter>num</parameter></methodparam>
   <methodparam><type>int</type><parameter>index</parameter></methodparam>
  </methodsynopsis>
  <para>
   Clears (sets to 0) bit <parameter>index</parameter> in
   <parameter>num</parameter>. The index starts at 0.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>num</parameter></term>
     <listitem>
      <para>
       A <classname>GMP</classname> object.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>index</parameter></term>
     <listitem>
      <para>
       The index of the bit to clear.  Index 0 represents the least significant bit.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>gmp_clrbit</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$a = gmp_init("0xff");
gmp_clrbit($a, 0); // index starts at 0, least significant bit
echo gmp_strval($a) . "\n";
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
254
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Unlike most of the other GMP functions, <function>gmp_clrbit</function>
    must be called with a GMP object that already exists (using
    <function>gmp_init</function> for example). One will not be
    automatically created.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>gmp_setbit</function></member>
    <member><function>gmp_testbit</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->