e8771524df501e68c33a0c8648611cdf871c6766
[scilab.git] / scilab / modules / elementary_functions / help / en_US / floating_point / isinf.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - INRIA
5  * 
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="isinf" xml:lang="en">
17     <refnamediv>
18         <refname>isinf</refname>
19         <refpurpose>check for infinite entries</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>r=isinf(x)</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>x</term>
30                 <listitem>
31                     <para>real or complex vector or matrix r : boolean vector or
32                         matrix
33                     </para>
34                 </listitem>
35             </varlistentry>
36         </variablelist>
37     </refsection>
38     <refsection>
39         <title>Description</title>
40         <para>
41             <literal>isinf(x)</literal> returns a boolean vector or matrix which
42             contains true entries corresponding with infinite <literal>x</literal>
43             entries and false entries corresponding with finite <literal>x</literal>
44             entries.
45         </para>
46     </refsection>
47     <refsection>
48         <title>Examples</title>
49         <programlisting role="example"><![CDATA[ 
50 isinf([1 0.01 -%inf %inf])
51  ]]></programlisting>
52     </refsection>
53     <refsection role="see also">
54         <title>See also</title>
55         <simplelist type="inline">
56             <member>
57                 <link linkend="isnan">isnan</link>
58             </member>
59         </simplelist>
60     </refsection>
61 </refentry>