is-nan.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 61374bbe228e8e9c55a24aba59a1e2bb2a871148 Maintainer: dallas Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<refentry xml:id="function.is-nan" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>is_nan</refname>
  <refpurpose>判断浮点数是否是否为 NAN</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>is_nan</methodname>
   <methodparam><type>float</type><parameter>num</parameter></methodparam>
  </methodsynopsis>
  <para>
   返回指定的 <parameter>num</parameter> 是否是 <constant>NAN</constant>（<quote>非数值</quote>）。
  </para>
  <para>
   <constant>NAN</constant> 是从未定义的数学运算中返回的，例如传递的参数在函数的输入域之外的时候。平方根（<function>sqrt</function>）仅对正数定义，传递负数将导致
   <constant>NAN</constant>。返回 <constant>NAN</constant> 的其它操作示例有 <constant>INF</constant> 除以 <constant>INF</constant>
   以及涉及现有 <constant>NAN</constant> 值的任何操作。
  </para>
  <note>
   <para>
    尽管名字叫 <quote>Not A Number</quote>，但 <constant>NAN</constant> 是有效的 &float; 类型。
   </para>
  </note>
  <caution>
   <para>
    <constant>NAN</constant> 不能与 <constant>NAN</constant> 进行比较。要检测浮点数是否是 <constant>NAN</constant>，必须使用
    <function>is_nan</function>。使用 <code>$float === NAN</code> 检测将不起作用。
   </para>
  </caution>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>num</parameter></term>
     <listitem>
      <para>
       要检查的 &float;
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   如果 <parameter>num</parameter> 是 <constant>NAN</constant>，返回 &true;，否则返回 &false;。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>is_nan</function> 示例</title>
    <programlisting role="php">
<![CDATA[
<?php
$nan = sqrt(-1);

var_dump($nan, is_nan($nan));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
float(NAN)
bool(true)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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