mirror of
https://github.com/php/doc-en.git
synced 2026-03-26 08:42:21 +01:00
108 lines
2.9 KiB
XML
108 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.bcdivmod" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<refnamediv>
|
|
<refname>bcdivmod</refname>
|
|
<refpurpose>Get the quotient and modulus of an arbitrary precision number</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>bcdivmod</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>
|
|
<simpara>
|
|
Get the quotient and remainder of dividing <parameter>num1</parameter> by
|
|
<parameter>num2</parameter>.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.bcdiv')/db:refsect1[@role='parameters']/*)" />
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<simpara>
|
|
Returns an indexed <type>array</type> where the first element is the quotient as a <type>string</type>
|
|
and the second element is the remainder as a <type>string</type>.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.bcdiv')/db:refsect1[@role='errors'])" />
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>bcdivmod</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
bcscale(0);
|
|
|
|
[$quot, $rem] = bcdivmod('5', '3');
|
|
echo $quot; // 1
|
|
echo $rem; // 2
|
|
|
|
[$quot, $rem] = bcdivmod('5', '-3');
|
|
echo $quot; // -1
|
|
echo $rem; // 2
|
|
|
|
[$quot, $rem] = bcdivmod('-5', '3');
|
|
echo $quot; // -1
|
|
echo $rem; // -2
|
|
|
|
[$quot, $rem] = bcdivmod('-5', '-3');
|
|
echo $quot; // 1
|
|
echo $rem; // -2
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<example>
|
|
<title><function>bcdivmod</function> with decimals</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
[$quot, $rem] = bcdivmod('5.7', '1.3', 1);
|
|
echo $quot; // 4
|
|
echo $rem; // 0.5
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>bcdiv</function></member>
|
|
<member><function>bcmod</function></member>
|
|
<member><methodname>BcMath\Number::divmod</methodname></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|