File: intdiv.xml

package info (click to toggle)
php-doc 20250827~git.abe740d%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 71,968 kB
  • sloc: xml: 985,760; php: 25,504; javascript: 671; sh: 177; makefile: 37
file content (145 lines) | stat: -rw-r--r-- 3,791 bytes parent folder | download
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
143
144
145
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.intdiv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>intdiv</refname>
  <refpurpose>Integer division</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>intdiv</methodname>
   <methodparam><type>int</type><parameter>num1</parameter></methodparam>
   <methodparam><type>int</type><parameter>num2</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns the integer quotient of the division of <parameter>num1</parameter> by <parameter>num2</parameter>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>num1</parameter></term>
    <listitem>
     <para>
      Number to be divided.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>num2</parameter></term>
    <listitem>
     <para>
      Number which divides the <parameter>num1</parameter>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The integer quotient of the division of <parameter>num1</parameter> by <parameter>num2</parameter>.
  </para>
 </refsect1>
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
    If <parameter>num2</parameter> is <literal>0</literal>, a <classname>DivisionByZeroError</classname>
    exception is thrown. If the <parameter>num1</parameter> is <constant>PHP_INT_MIN</constant>
    and the <parameter>num2</parameter> is <literal>-1</literal>, then an
    <classname>ArithmeticError</classname> exception is thrown.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>intdiv</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
var_dump(intdiv(3, 2));
var_dump(intdiv(-3, 2));
var_dump(intdiv(3, -2));
var_dump(intdiv(-3, -2));
var_dump(intdiv(PHP_INT_MAX, PHP_INT_MAX));
var_dump(intdiv(PHP_INT_MIN, PHP_INT_MIN));
?>
]]>
    </programlisting>
   &example.outputs;
    <screen>
<![CDATA[
int(1)
int(-1)
int(-1)
int(1)
int(1)
int(1)
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title><function>intdiv</function> Example With Invalid Divisor</title>
    <programlisting role="php">
<![CDATA[
<?php
try {
    intdiv(PHP_INT_MIN, -1);
} catch (Error $e) {
    echo get_class($e), ': ', $e->getMessage(), PHP_EOL;
}

try {
    intdiv(1, 0);
} catch (Error $e) {
    echo get_class($e), ': ', $e->getMessage(), PHP_EOL;
}
?>
]]>
    </programlisting>
   &example.outputs;
    <screen>
<![CDATA[
ArithmeticError: Division of PHP_INT_MIN by -1 is not an integer
DivisionByZeroError: Division by zero
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="language.operators.arithmetic"><literal>/</literal></link> - Floating-point division</member>
    <member><link linkend="language.operators.arithmetic"><literal>%</literal></link> - Integer modulus</member>
    <member><function>fmod</function> - Floating-point modulo</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
-->