mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
b8758b0605
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343899 c90b9560-bf6c-de11-be94-00142212c4b1
174 lines
4 KiB
XML
174 lines
4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-setbit">
|
|
<refnamediv>
|
|
<refname>gmp_setbit</refname>
|
|
<refpurpose>Set bit</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>gmp_setbit</methodname>
|
|
<methodparam><type>GMP</type><parameter>a</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>index</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>bit_on</parameter><initializer>&true;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets bit <parameter>index</parameter> in <parameter>a</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>a</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The value to modify.
|
|
</para>
|
|
&gmp.parameter;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>index</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The index of the bit to set. Index 0 represents the least significant bit.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>bit_on</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
True to set the bit (set it to 1/on); false to clear the bit (set it to 0/off).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&gmp.return;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>gmp_setbit</function> example - 0 index</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$a = gmp_init("2"); //
|
|
echo gmp_strval($a), ' -> 0b', gmp_strval($a, 2), "\n";
|
|
gmp_setbit($a, 0); // 0b10 now becomes 0b11
|
|
echo gmp_strval($a), ' -> 0b', gmp_strval($a, 2), "\n";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
2 -> 0b10
|
|
3 -> 0b11
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
|
|
<example>
|
|
<title><function>gmp_setbit</function> example - 1 index</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$a = gmp_init("0xfd");
|
|
echo gmp_strval($a), ' -> 0b', gmp_strval($a, 2), "\n";
|
|
gmp_setbit($a, 1); // index starts at 0
|
|
echo gmp_strval($a), ' -> 0b', gmp_strval($a, 2), "\n";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
253 -> 0b11111101
|
|
255 -> 0b11111111
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
|
|
<example>
|
|
<title><function>gmp_setbit</function> example - clearing a bit</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$a = gmp_init("0xff");
|
|
echo gmp_strval($a), ' -> 0b', gmp_strval($a, 2), "\n";
|
|
gmp_setbit($a, 0, false); // clear bit at index 0
|
|
echo gmp_strval($a), ' -> 0b', gmp_strval($a, 2), "\n";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
255 -> 0b11111111
|
|
254 -> 0b11111110
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
Unlike most of the other GMP functions, <function>gmp_setbit</function>
|
|
must be called with a GMP resource 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_clrbit</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
|
|
-->
|