doc-fr/reference/bc/functions/bcmod.xml at master · php/doc-fr · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c7e83fbbbcde9f54affc09424d032c38492a3ff4 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.bcmod" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 <refnamediv>
  <refname>bcmod</refname>
  <refpurpose>Retourne le reste d'une division entre nombres de grande taille</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>bcmod</methodname>
   <methodparam><type>string</type><parameter>num1</parameter></methodparam>
   <methodparam><type>string</type><parameter>num2</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>scale</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Retourne le reste de la division de <parameter>num1</parameter>
   par <parameter>num2</parameter>.
   Le résultat a le même signe que <parameter>num1</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.bcadd')/db:refsect1[@role='parameters']/*)" />
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne le modulo, sous la forme d'une &string;.
  </para>
 </refsect1>

 <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.bcdiv')/db:refsect1[@role='errors'])" />

 <refsect1 role="changelog"><!-- {{{ -->
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>scale</parameter> est désormais nullable.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       La division par <literal>0</literal> lève désormais une exception
       <exceptionname>DivisionByZeroError</exceptionname> au lieu de retourner null.
      </entry>
     </row>
     <row>
      <entry>7.2.0</entry>
      <entry>
       <parameter>num1</parameter> et <parameter>num2</parameter> ne sont
       plus tronqués en entier. Le comportement de <function>bcmod</function>
       suit <function>fmod</function> plutôt que l'opérateur <literal>%</literal>.
      </entry>
     </row>
     <row>
      <entry>7.2.0</entry>
      <entry>
       Le paramètre <parameter>scale</parameter> a été ajouté.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1><!-- }}} -->

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple avec <function>bcmod</function></title>
   <programlisting role="php">
<![CDATA[
<?php
bcscale(0);
echo bcmod( '5',  '3'); //  2
echo bcmod( '5', '-3'); //  2
echo bcmod('-5',  '3'); // -2
echo bcmod('-5', '-3'); // -2
?>
]]>
   </programlisting>
  </example>

  <example>
   <title><function>bcmod</function> avec des décimales</title>
   <programlisting role="php">
<![CDATA[
<?php
bcscale(1);
echo bcmod('5.7', '1.3'); // 0.5 à partir de PHP 7.2.0; 0 précédemment
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>bcdiv</function></member>
    <member><function>bcdivmod</function></member>
    <member><methodname>BcMath\Number::mod</methodname></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
-->