rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / isnan.xml
CommitLineData
7faf1d71
AW
1<?xml version="1.0" encoding="UTF-8"?>\r
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
4<refentry id="isnan">\r
5 <refmeta>\r
6 <refmetainfo>\r
7 <copyright>\r
8 <year>2011</year>\r
9 <holder>Khronos Group</holder>\r
10 </copyright>\r
11 </refmetainfo>\r
12 <refentrytitle>isnan</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>isnan</refname>\r
17 <refpurpose>determine whether the parameter is a number</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>Declaration</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>genBType <function>isnan</function></funcdef>\r
23 <paramdef>genType <parameter>x</parameter></paramdef>\r
24 </funcprototype>\r
25 <funcprototype>\r
26 <funcdef>genBType <function>isnan</function></funcdef>\r
27 <paramdef>genDType <parameter>x</parameter></paramdef>\r
28 </funcprototype>\r
29 </funcsynopsis>\r
30 </refsynopsisdiv>\r
31 <refsect1 id="parameters"><title>Parameters</title>\r
32 <variablelist>\r
33 <varlistentry>\r
34 <term><parameter>x</parameter></term>\r
35 <listitem>\r
36 <para>\r
37 Specifies the value to test for NaN.\r
38 </para>\r
39 </listitem>\r
40 </varlistentry>\r
41 </variablelist>\r
42 </refsect1>\r
43 <refsect1 id="description"><title>Description</title>\r
44 <para>\r
45 For each element element <emphasis>i</emphasis> of the result, <function>isinf</function> returns <constant>true</constant> if\r
46 <parameter>x</parameter>[<emphasis>i</emphasis>] is posititve or negative floating point NaN (Not a Number) and false otherwise.\r
47 </para>\r
48 </refsect1>\r
49 <refsect1 id="versions"><title>Version Support</title>\r
50 <informaltable frame="topbot">\r
51 #VARTABLECOLS#\r
52 <thead>\r
53 #FUNCTABLEHEADER#\r
54 <row>\r
55 <entry>isnan (genType)</entry>#newin13#\r
56 </row>\r
57 <row>\r
58 <entry>isnan (genDType)</entry>#newin40#\r
59 </row>\r
60 </thead>\r
61 </tgroup>\r
62 </informaltable>\r
63 </refsect1>\r
64 <refsect1 id="seealso"><title>See Also</title>\r
65 <para>\r
66 <citerefentry><refentrytitle>isinf</refentrytitle></citerefentry>\r
67 </para>\r
68 </refsect1>\r
69 <refsect1 id="Copyright"><title>Copyright</title>\r
70 <para>\r
71 Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
72 This material may be distributed subject to the terms and conditions set forth in \r
73 the Open Publication License, v 1.0, 8 June 1999.\r
74 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
75 </para>\r
76 </refsect1>\r
77</refentry>\r