Revert f56158b2 "[doc] string pages improved" for specific files where
[scilab.git] / scilab / modules / string / help / en_US / isdigit.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) 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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="isdigit">
17     <refnamediv>
18         <refname>isdigit</refname>
19         <refpurpose>
20             check that characters of a string are digits between 0 and 9
21         </refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Syntax</title>
25         <synopsis>res = isdigit(str)</synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Arguments</title>
29         <variablelist>
30             <varlistentry>
31                 <term>str</term>
32                 <listitem>
33                     <para>a character string.</para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>res</term>
38                 <listitem>
39                     <para>a boolean matrix.</para>
40                 </listitem>
41             </varlistentry>
42         </variablelist>
43     </refsection>
44     <refsection>
45         <title>Description</title>
46         <para>
47             <code>res = isdigit(str)</code> returns an array the same size as
48             <varname>str</varname> containing logical <constant>%t</constant>
49             (TRUE) where the elements of <varname>str</varname> are digits and
50             logical <constant>%f</constant> (FALSE) where they are not.
51         </para>
52     </refsection>
53     <refsection>
54         <title>Examples</title>
55         <programlisting role="example"><![CDATA[
56 s = 'A1,B2,C3';
57 isdigit(s)
58  ]]></programlisting>
59     </refsection>
60     <refsection role="see also">
61         <title>See also</title>
62         <simplelist type="inline">
63             <member>
64                 <link linkend="isalphanum">isalphanum</link>
65             </member>
66             <member>
67                 <link linkend="isletter">isletter</link>
68             </member>
69             <member>
70                 <link linkend="isnum">isnum</link>
71             </member>
72         </simplelist>
73     </refsection>
74 </refentry>