<?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="iscolumn" xml:lang="ja">

    <refnamediv>

        <refname>iscolumn</refname>

        <refpurpose>変数が列ベクトルであるかを確認</refpurpose>

    </refnamediv>

    <refsynopsisdiv>

        <title>呼び出し手順</title>

        <synopsis>t=iscolumn(x)</synopsis>

    </refsynopsisdiv>

    <refsection>

        <title>引数</title>

        <variablelist>

            <varlistentry>

                <term>x</term>

                <listitem>

                    <para>スカラー,ベクトル, 行列, ハイパー行列, リスト, 構造体の配列またはセル</para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>t</term>

                <listitem>

                    <para>論理値</para>

                </listitem>

            </varlistentry>

        </variablelist>

    </refsection>

    <refsection>

        <title>説明</title>

        <para>

            <literal>

                iscolumn(<varname>x</varname>)

            </literal>

            は

            <varname>x</varname>が列ベクトルの場合にtrueを返します.

            スカラーは列ベクトルとみなされます.

            <literal>iscolumn([])</literal>はfalseを返すことに注意してください.

        </para>

    </refsection>

    <refsection>

        <title>例</title>

        <programlisting role="example"><![CDATA[
iscolumn(ones(10,1))
iscolumn(1)
iscolumn(["s"; "t"; "u"])
iscolumn(rand(3,1,1))
iscolumn(rand(1,1,3))
s = struct();
iscolumn(s) // 空の構造体
clear s
s.a = %z;
s.b = 2;
iscolumn(s) // 構造体のスカラー配列
clear s
s(2,1).a = "w";
s(3,1).b = %t;
iscolumn(s) // 構造体の列配列
clear s
s(1,2).a = -2;
s(3,1).b = %pi;
iscolumn(s) // 構造体の2次元配列
clear s
s(1,1,2).a = 3;
s(1,1,3).b = "test";
iscolumn(s) // 構造体の3次元配列 (うち2つの次元は1要素)
 ]]></programlisting>

    </refsection>

    <refsection role="see also">

        <title>参照</title>

        <simplelist type="inline">

            <member>

                <link linkend="isscalar">isscalar</link>

            </member>

            <member>

                <link linkend="isrow">isrow</link>

            </member>

            <member>

                <link linkend="ismatrix">ismatrix</link>

            </member>

            <member>

                <link linkend="issquare">issquare</link>

            </member>

            <member>

                <link linkend="isempty">isempty</link>

            </member>

        </simplelist>

    </refsection>

    <refsection>

        <title>履歴</title>

        <revhistory>

            <revision>

                <revnumber>5.5.0</revnumber>

                <revremark>関数iscolumnが導入されました.</revremark>

            </revision>

        </revhistory>

    </refsection>

</refentry>

