is-finite.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.is-finite" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>is_finite</refname>
  <refpurpose>Checks whether a float is finite</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>is_finite</methodname>
   <methodparam><type>float</type><parameter>num</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns whether the given <parameter>num</parameter> is a finite float.
  </para>
  <para>
   A finite float is neither <constant>NAN</constant> (<function>is_nan</function>),
   nor infinite (<function>is_infinite</function>).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>num</parameter></term>
     <listitem>
      <para>
       The &float; to check
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &true; if <parameter>num</parameter> is none of <constant>NAN</constant>,
   <constant>INF</constant>, -<constant>INF</constant>, else &false;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>is_finite</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$float = 1.2345;
var_dump($float, is_finite($float));

$nan = sqrt(-1);
var_dump($nan, is_finite($nan));

$inf = 1e308 * 2;
var_dump($inf, is_finite($inf));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
float(1.2345)
bool(true)
float(NAN)
bool(false)
float(INF)
bool(false)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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