bcmul.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.bcmul" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 <refnamediv>
  <refname>bcmul</refname>
  <refpurpose>Multiply two arbitrary precision numbers</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>bcmul</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>
   Multiply <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.bcadd')/db:refsect1[@role='parameters']/*)" />
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the result as a string.
  </para>
 </refsect1>

 <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.bcadd')/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> is now nullable.
      </entry>
     </row>
     <row>
      <entry>7.3.0</entry>
      <entry>
       <function>bcmul</function> now returns numbers with the requested scale.
       Formerly, the returned numbers may have omitted trailing decimal zeroes.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1><!-- }}} -->

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>bcmul</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
echo bcmul('1.34747474747', '35', 3); // 47.161
echo bcmul('2', '4'); // 8
?>
]]>
   </programlisting>
  </example>
 </refsect1>
 
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Prior to PHP 7.3.0, <function>bcmul</function> may return a result with fewer digits after the
    decimal point than the <parameter>scale</parameter> parameter would
    indicate. This only occurs when the result doesn't require all of the
    precision allowed by the <parameter>scale</parameter>. For example:
    <example>
     <title><function>bcmul</function> scale example</title>
     <programlisting role="php">
<![CDATA[
<?php
echo bcmul('5', '2', 2);     // prints "10", not "10.00"
?>
]]>
     </programlisting>
    </example>
   </para>
  </note>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>bcdiv</function></member>
    <member><methodname>BcMath\Number::mul</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
-->