-
Notifications
You must be signed in to change notification settings - Fork 858
Expand file tree
/
Copy pathfmod.xml
More file actions
107 lines (106 loc) · 2.95 KB
/
fmod.xml
File metadata and controls
107 lines (106 loc) · 2.95 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<?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>num1</parameter></methodparam>
<methodparam><type>float</type><parameter>num2</parameter></methodparam>
</methodsynopsis>
<para>
Returns the floating point remainder of dividing the dividend
(<parameter>num1</parameter>) by the divisor (<parameter>num2</parameter>).
The remainder (<varname>r</varname>) is defined as: num1 = i * num2 + r, for
some integer <varname>i</varname>. If <parameter>num2</parameter> is
non-zero, <varname>r</varname> has the same sign as
<parameter>num1</parameter> and a magnitude less than the magnitude of
<parameter>num2</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>num1</parameter></term>
<listitem>
<para>
The dividend
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>num2</parameter></term>
<listitem>
<para>
The divisor
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The floating point remainder of
<parameter>num1</parameter>/<parameter>num2</parameter>.
<constant>NAN</constant> (<type>float</type>) if the second argument is 0.
</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
var_dump($x, $y, $r);
?>
]]>
</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
-->