archived-doc-ja/reference/math/functions/fmod.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 54a788ca59d95ff2b4189406437345a21b489435 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.fmod" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fmod</refname>
  <refpurpose>引数で除算をした際の剰余を返す</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>
   被除数（<parameter>num1</parameter>）を除数（<parameter>num2</parameter>）
   で割った余りを返します。余り（<varname>r</varname>）は、
   整数 <varname>i</varname> を使用して num1 = i * num2 + r で定義されます。
   <parameter>num2</parameter> がゼロ以外の場合は<varname>r</varname>
   は <parameter>num1</parameter> と同符号で、絶対値は <parameter>num2</parameter>
   より小さくなります。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>num1</parameter></term>
     <listitem>
      <para>
       被除数。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>num2</parameter></term>
     <listitem>
      <para>
       除数。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>num1</parameter>/<parameter>num2</parameter> の浮動小数点の剰余を返します。
   第二引数が 0 の場合は <constant>NAN</constant> (<type>float</type>) を返します。
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>fmod</function> の使用法</title>
    <programlisting role="php">
<![CDATA[
<?php
$x = 5.7;
$y = 1.3;
$r = fmod($x, $y);
// $r は 0.5 です。なぜなら 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> - 浮動小数点数値の除算</member>
    <member><link linkend="language.operators.arithmetic"><literal>%</literal></link> - 整数値の剰余</member>
    <member><function>intdiv</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
-->