<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="bcmath-number.div" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <refnamediv>
  <refname>BcMath\Number::div</refname>
  <refpurpose>Divides by an arbitrary precision number</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="BcMath\\Number">
   <modifier>public</modifier> <type>BcMath\Number</type><methodname>BcMath\Number::div</methodname>
   <methodparam><type class="union"><type>BcMath\Number</type><type>string</type><type>int</type></type><parameter>num</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>scale</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   Divides <varname>$this</varname> by <parameter>num</parameter>.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>num</parameter></term>
    <listitem>
     <simpara>
      The divisor.
     </simpara>
    </listitem>
   </varlistentry>
   <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('bcmath-number.add')/db:refsect1[@role='parameters']/descendant::db:varlistentry[2])" />
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Returns the result of division as a new <classname>BcMath\Number</classname> object.
  </simpara>
  <simpara>
   When the <property>BcMath\Number::scale</property> of the result object is automatically set,
   the <property>BcMath\Number::scale</property> of the dividend is used. However, in cases such
   as indivisible division, the <property>BcMath\Number::scale</property> of the result is expanded.
   Expansion is done only as needed, up to a maximum of <literal>+10</literal>.
  </simpara>
  <simpara>
   That is, if the <property>BcMath\Number::scale</property> of the dividend is <literal>5</literal>,
   the <property>BcMath\Number::scale</property> of the result is between <literal>5</literal> and
   <literal>15</literal>.
  </simpara>
  <simpara>
   Even in indivisible calculations, the <property>BcMath\Number::scale</property> will not always be
   <literal>+10</literal>.
   A <literal>0</literal> at the end of the result is considered not to need expansion, so the
   <property>BcMath\Number::scale</property> is reduced by that amount.
   The <property>BcMath\Number::scale</property> will never be less than the
   <property>BcMath\Number::scale</property> before expansion.
   See also the <link linkend="bcmath-number.div.example.expansion-scale">code example</link>.
  </simpara>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   This method throws a <exceptionname>ValueError</exceptionname> in the following cases:
   <simplelist>
    <member><parameter>num</parameter> is <type>string</type> and not a well-formed BCMath numeric string</member>
    <member><parameter>scale</parameter> is outside the valid range</member>
    <member><property>BcMath\Number::scale</property> of the result object is outside the valid range</member>
   </simplelist>
  </para>
  <simpara>
   This method throws a <exceptionname>DivisionByZeroError</exceptionname> exception if
   <parameter>num</parameter> is <literal>0</literal>.
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><methodname>BcMath\Number::div</methodname> example when <parameter>scale</parameter> is not specified</title>
   <programlisting role="php">
<![CDATA[
<?php
$number = new BcMath\Number('0.002');

$ret1 = $number->div(new BcMath\Number('2.000'));
$ret2 = $number->div('-3');
$ret3 = $number->div(32);

var_dump($number, $ret1, $ret2, $ret3);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
object(BcMath\Number)#1 (2) {
  ["value"]=>
  string(5) "0.002"
  ["scale"]=>
  int(3)
}
object(BcMath\Number)#3 (2) {
  ["value"]=>
  string(5) "0.001"
  ["scale"]=>
  int(3)
}
object(BcMath\Number)#2 (2) {
  ["value"]=>
  string(16) "-0.0006666666666"
  ["scale"]=>
  int(13)
}
object(BcMath\Number)#4 (2) {
  ["value"]=>
  string(9) "0.0000625"
  ["scale"]=>
  int(7)
}
]]>
   </screen>
  </example>

  <example>
   <title><methodname>BcMath\Number::div</methodname> example of explicitly specifying <parameter>scale</parameter></title>
   <programlisting role="php">
<![CDATA[
<?php
$number = new BcMath\Number('0.002');

$ret1 = $number->div(new BcMath\Number('2.000'), 15);
$ret2 = $number->div('-3', 5);
$ret3 = $number->div(32, 2);

var_dump($number, $ret1, $ret2, $ret3);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
object(BcMath\Number)#1 (2) {
  ["value"]=>
  string(5) "0.002"
  ["scale"]=>
  int(3)
}
object(BcMath\Number)#3 (2) {
  ["value"]=>
  string(17) "0.001000000000000"
  ["scale"]=>
  int(15)
}
object(BcMath\Number)#2 (2) {
  ["value"]=>
  string(8) "-0.00066"
  ["scale"]=>
  int(5)
}
object(BcMath\Number)#4 (2) {
  ["value"]=>
  string(4) "0.00"
  ["scale"]=>
  int(2)
}
]]>
   </screen>
  </example>

  <example xml:id="bcmath-number.div.example.expansion-scale">
   <title><methodname>BcMath\Number::div</methodname> example of expansioning <property>BcMath\Number::scale</property> of result object</title>
   <programlisting role="php">
<![CDATA[
<?php
var_dump(
    new BcMath\Number('0.001')->div('10001'),
    new BcMath\Number('0.001')->div('10001', 13),
    new BcMath\Number('0.001')->div('100000000000001'),
);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
object(BcMath\Number)#2 (2) {
  ["value"]=>
  string(13) "0.00000009999"
  ["scale"]=>
  int(11)
}
object(BcMath\Number)#3 (2) {
  ["value"]=>
  string(15) "0.0000000999900"
  ["scale"]=>
  int(13)
}
object(BcMath\Number)#4 (2) {
  ["value"]=>
  string(5) "0.000"
  ["scale"]=>
  int(3)
}
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>bcdiv</function></member>
   <member><methodname>BcMath\Number::divmod</methodname></member>
   <member><methodname>BcMath\Number::mod</methodname></member>
   <member><methodname>BcMath\Number::sqrt</methodname></member>
   <member><methodname>BcMath\Number::pow</methodname></member>
   <member><methodname>BcMath\Number::mul</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
-->