<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2013 - Scilab Enterprises
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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="isscalar" xml:lang="en">
    <refnamediv>
        <refname>isscalar</refname>
        <refpurpose>
            check if a variable is a scalar.
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>t=isscalar(x)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>x</term>
                <listitem>
                    <para>scalar,vector, matrix, hypermatrix, list, array of structures or cells</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>t</term>
                <listitem>
                    <para>a boolean</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>
                isscalar(<varname>x</varname>)
            </literal>
            returns true if <varname>x</varname>
            is a scalar (if size(<varname>x</varname>) is 1). Note that <literal>isscalar([])</literal>
            returns false.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
isscalar(ones(10,10))
isscalar(1)
isscalar("s")
s = struct();
isscalar(s) // Empty structure
clear s
s.a = %z;
s.b = 2;
isscalar(s) // Scalar structure
clear s
s(1,2).a = 3;
s(1,3).b = %z;
isscalar(s) // Row array of structures
clear s
s(2,1).a = "w";
s(3,1).b = %t;
isscalar(s) // Column array of structures
 ]]></programlisting>
    </refsection>
    <refsection role= "see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="ismatrix">ismatrix</link>
            </member>
            <member>
                <link linkend="isrow">isrow</link>
            </member>
            <member>
                <link linkend="iscolumn">iscolumn</link>
            </member>
            <member>
                <link linkend="issquare">issquare</link>
            </member>
            <member>
                <link linkend="isempty">isempty</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>History</title>
        <revhistory>
            <revision>
                <revnumber>5.5.0</revnumber>
                <revremark>Function isscalar introduced.</revremark>
            </revision>
        </revhistory>
    </refsection>
</refentry>
