<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: 61374bbe228e8e9c55a24aba59a1e2bb2a871148 Maintainer: das Status: ready -->

<!-- Reviewed: no -->

<refentry xml:id="function.is-nan" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>is_nan</refname>

<refpurpose>Проверяет, представляет ли собой число с плавающей точкой нечисло</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>Not A Number</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>нечисло</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>

Функция возвращает &true;, если значение параметра <parameter>num</parameter> — нечисло (<constant>NAN</constant>),

иначе &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

-->