<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA
 *
 * 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: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="squeeze">
    <refnamediv>
        <refname>squeeze</refname>
        <refpurpose>removes singleton dimensions of a hypermatrix</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>hypOut = squeeze(hypIn)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>hypIn</term>
                <listitem>
                    <para>a hypermatrix or matrix of constant type.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>hypOut</term>
                <listitem>
                    <para>a hypermatrix or matrix of constant type.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            The <function>squeeze</function> function removes singleton dimensions of a
            hypermatrix, that is any dimension for which the size is <literal>1</literal>. If
            the input <varname>hypIn</varname> is a matrix, it is unaffected.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
	M1 = zeros(2,1,5)
	squeeze(M1)
	squeeze(M1(:,:,1))

	M2 = matrix(1:4, [2 1 2 1])
	squeeze(M2)
	]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="matrix">matrix</link>
            </member>
            <member>
                <link linkend="hypermatrices">hypermatrices</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
