php-doc-en/reference/math/functions/fmod.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fmod" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fmod</refname>
  <refpurpose>Returns the floating point remainder (modulo) of the division
  of the arguments</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
   <methodsynopsis>
    <type>float</type><methodname>fmod</methodname>
    <methodparam><type>float</type><parameter>x</parameter></methodparam>
    <methodparam><type>float</type><parameter>y</parameter></methodparam>
   </methodsynopsis>
  <para>
   Returns the floating point remainder of dividing the dividend
   (<parameter>x</parameter>) by the divisor (<parameter>y</parameter>).
   The remainder (<varname>r</varname>) is defined as: x = i * y + r, for 
   some integer <varname>i</varname>. If <parameter>y</parameter> is
   non-zero, <varname>r</varname> has the same sign as
   <parameter>x</parameter> and a magnitude less than the magnitude of
   <parameter>y</parameter>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>x</parameter></term>
     <listitem>
      <para>
       The dividend
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>y</parameter></term>
     <listitem>
      <para>
       The divisor
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The floating point remainder of 
   <parameter>x</parameter>/<parameter>y</parameter>
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Using <function>fmod</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$x = 5.7;
$y = 1.3;
$r = fmod($x, $y);
// $r equals 0.5, because 4 * 1.3 + 0.5 = 5.7
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="language.operators.arithmetic"><literal>/</literal></link> - Floating-point division</member>
    <member><link linkend="language.operators.arithmetic"><literal>%</literal></link> - Integer modulus</member>
    <member><function>intdiv</function> - Integer division</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
-->