gmp-div-q.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.gmp-div-q" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>gmp_div_q</refname>
  <refpurpose>Divide numbers</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>GMP</type><methodname>gmp_div_q</methodname>
   <methodparam><type class="union"><type>GMP</type><type>int</type><type>string</type></type><parameter>num1</parameter></methodparam>
   <methodparam><type class="union"><type>GMP</type><type>int</type><type>string</type></type><parameter>num2</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>rounding_mode</parameter><initializer><constant>GMP_ROUND_ZERO</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   Divides <parameter>num1</parameter> by <parameter>num2</parameter> and
   returns the integer result. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>num1</parameter></term>
     <listitem>
      <para>
       The number being divided.
      </para>
      &gmp.parameter; 
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>num2</parameter></term>
     <listitem>
      <para>
       The number that <parameter>num1</parameter> is being divided by.
      </para>
      &gmp.parameter; 
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>rounding_mode</parameter></term>
     <listitem>
      <para>
       The result rounding is defined by the
       <parameter>rounding_mode</parameter>, which can have the following
       values:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>GMP_ROUND_ZERO</constant>: The result is truncated
          towards 0.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>GMP_ROUND_PLUSINF</constant>: The result is
          rounded towards <literal>+infinity</literal>.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>GMP_ROUND_MINUSINF</constant>: The result is
          rounded towards <literal>-infinity</literal>.
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
      &gmp.parameter;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &gmp.return;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>gmp_div_q</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$div1 = gmp_div_q("100", "5");
echo gmp_strval($div1) . "\n";

$div2 = gmp_div_q("1", "3");
echo gmp_strval($div2) . "\n";

$div3 = gmp_div_q("1", "3", GMP_ROUND_PLUSINF);
echo gmp_strval($div3) . "\n";

$div4 = gmp_div_q("-1", "4", GMP_ROUND_PLUSINF);
echo gmp_strval($div4) . "\n";

$div5 = gmp_div_q("-1", "4", GMP_ROUND_MINUSINF);
echo gmp_strval($div5) . "\n";
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
20
0
1
0
-1
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    This function can also be called as <function>gmp_div</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>gmp_div_r</function></member>
    <member><function>gmp_div_qr</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
-->