php-doc-en/reference/bc/functions/bcdiv.xml

101 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.bcdiv" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>bcdiv</refname>
<refpurpose>Divide two arbitrary precision numbers</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>bcdiv</methodname>
<methodparam><type>string</type><parameter>left_operand</parameter><initializer>""</initializer></methodparam>
<methodparam><type>string</type><parameter>right_operand</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scale</parameter><initializer>int</initializer></methodparam>
</methodsynopsis>
<para>
Divides the <parameter>left_operand</parameter> by the
<parameter>right_operand</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left_operand</parameter></term>
<listitem>
<para>
The left operand, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right_operand</parameter></term>
<listitem>
<para>
The right operand, as a string.
</para>
</listitem>
</varlistentry>
&bc.scale.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the result of the division as a string, or &null; if
<parameter>right_operand</parameter> is 0.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>bcdiv</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo bcdiv('105', '6.55957', 3); // 16.007
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>bcmul</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
-->