php-doc-en/reference/math/functions/intdiv.xml
Andrea Faulds e2cda72271 Correct the other half of intdiv()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337971 c90b9560-bf6c-de11-be94-00142212c4b1
2015-10-08 14:50:40 +00:00

112 lines
3 KiB
XML

<?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>dividend</parameter></methodparam>
<methodparam><type>int</type><parameter>divisor</parameter></methodparam>
</methodsynopsis>
<para>
Returns the integer quotient of the division of <parameter>dividend</parameter> by <parameter>divisor</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>dividend</parameter></term>
<listitem>
<para>
Number to be divided.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>divisor</parameter></term>
<listitem>
<para>
Number which divides the <parameter>dividend</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The integer quotient of the division of <parameter>dividend</parameter> by <parameter>divisor</parameter>.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
If <parameter>divisor</parameter> is <literal>0</literal>, a <classname>DivisionByZeroError</classname>
exception is thrown. If the <parameter>dividend</parameter> is <constant>PHP_INT_MIN</constant>
and the <parameter>divisor</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));
var_dump(intdiv(PHP_INT_MIN, -1));
var_dump(intdiv(1, 0));
?>
]]>
</programlisting>
<screen>
<![CDATA[
int(1)
int(-1)
int(-1)
int(1)
int(1)
int(1)
Fatal error: Uncaught ArithmeticError: Division of PHP_INT_MIN by -1 is not an integer in %s on line 8
Fatal error: Uncaught DivisionByZeroError: Division by zero in %s on line 9
]]>
</screen>
</example>
</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
-->