9b66823ee93afedd335d9465d6cf422551d5ec83
[scilab.git] / scilab / modules / elementary_functions / help / en_US / IsAScalar.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) 2013 - Scilab Enterprises
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <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="IsAScalar" xml:lang="en">
14     <refnamediv>
15         <refname>IsAScalar</refname>
16         <refpurpose>
17             check if a variable is a scalar. <emphasis role="bold">This function is obsolete.</emphasis> 
18         </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>t=IsAScalar(x)</synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>x</term>
29                 <listitem>
30                     <para>vector or matrix</para>
31                 </listitem>
32             </varlistentry>
33             <varlistentry>
34                 <term>t</term>
35                 <listitem>
36                     <para>a boolean</para>
37                 </listitem>
38             </varlistentry>
39         </variablelist>
40     </refsection>
41     <refsection>
42         <title>Description</title>
43         <para>
44             <literal>
45                 IsAScalar(<varname>x</varname>)
46             </literal>
47             returns true if <varname>x</varname>
48             is a scalar (if size(<varname>x</varname>) is 1 and type(<varname>x</varname>,1) is 1 too).
49             <warning>This function is obsolete.</warning>
50             It is better to use <link linkend="isscalar">isscalar</link> instead of <code>IsAScalar</code>.
51         </para>
52     </refsection>
53     <refsection>
54         <title>Examples</title>
55         <programlisting role="example"><![CDATA[ 
56 IsAScalar(ones(10,10))
57 IsAScalar(1)
58 IsAScalar("s")
59  ]]></programlisting>
60     </refsection>
61     <refsection>
62         <title>History</title>
63         <revhistory>
64             <revision>
65                 <revnumber>5.5.0</revnumber>
66                 <revdescription>
67                     Function tagged as obsolete. Will be removed in 5.5.1. Please use <link linkend="isscalar">isscalar</link> instead.
68                 </revdescription>
69             </revision>
70         </revhistory>
71     </refsection>
72 </refentry>