Files
doc-fr/reference/gmp/functions/gmp-setbit.xml
2021-09-24 04:13:47 +01:00

179 lines
4.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 039ab719e695141ee54409d26ad828337ec31d6e Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.gmp-setbit" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>gmp_setbit</refname>
<refpurpose>Modifie un bit</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>gmp_setbit</methodname>
<methodparam><type>GMP</type><parameter>num</parameter></methodparam>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>value</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
Modifie le bit <parameter>index</parameter>
dans <parameter>num</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>num</parameter></term>
<listitem>
<para>
La valeur à modifier.
</para>
&gmp.parameter;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
L'index de l'octet à définir.
L'index 0 représente l'octet le moins significatif.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
&true; pour définir l'octet (défini à 1/on) ; &false;
pour le ré-initialiser (défini à 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>Exemple avec <function>gmp_setbit</function> - index 0</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 devient maintenant 0b11
echo gmp_strval($a), ' -> 0b', gmp_strval($a, 2), "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
2 -> 0b10
3 -> 0b11
]]>
</screen>
</example>
<example>
<title>Exemple avec <function>gmp_setbit</function> - index 1</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 commence à 0
echo gmp_strval($a), ' -> 0b', gmp_strval($a, 2), "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
253 -> 0b11111101
255 -> 0b11111111
]]>
</screen>
</example>
<example>
<title>Exemple avec <function>gmp_setbit</function> - annule un octet</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>
Contrairement à la plupart des autres fonctions GMP,
<function>gmp_setbit</function> doit être appelée avec un objet
GMP existant déjà (en utilisant <function>gmp_init</function> par
exemple). Elle ne sera pas automatiquement créée.
</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
-->