<?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
 * Copyright (C) 2020 - Samuel GOUGEON
 *
 * 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:db="http://docbook.org/ns/docbook"
          xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="squeeze">
    <refnamediv>
        <refname>squeeze</refname>
        <refpurpose>удаляет одиночные размерности ND-мерного массива</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Синтаксис</title>
        <synopsis>r = squeeze(hypIn)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Аргументы</title>
        <variablelist>
            <varlistentry>
                <term>hypIn</term>
                <listitem>
                    <para>
                        ND-мерный массив любого встроенного типа (логические,...
                        cell-массив, структуры)
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>r</term>
                <listitem>
                    <para>
                        массив или ND-мерный массив того же самого типа.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Описание</title>
        <para>
            <literal>squeeze(…)</literal> удаляет одиночные размерности гиперматрицы
            или ND-мерного массива, для которых размер равен <literal>1</literal>.
            Если на входе <varname>hypIn</varname> является матрицей, то она возвращается
            как есть.
        </para>
        <note>
            Scilab сжимает наивысшие одиночные размерности автоматически.
        </note>
    </refsection>
    <refsection>
        <title>Примеры</title>
        <programlisting role="example"><![CDATA[
// для двумерных входных матриц => нет действий
u = squeeze(ones(1,4))
size(u)

// автосжатие высших одиночных размерностей:
v = ones(2,3,1,1);
size(v)

// для фактического входного ND-мерного массива:
w = squeeze(ones(1,3,1,4))
size(w)

// для четырёхмерного cell-массива
c = cat(4, {%t}, {%pi}, {"abc"});
size(c)
x = squeeze(c)
size(x)
    ]]></programlisting>
    <screen><![CDATA[
--> u = squeeze(ones(1,4))
 u  =
   1.   1.   1.   1.

--> size(u)
 ans  =
   1.   4.

--> // автосжатие высших одиночных размерностей:
--> v = ones(2,3,1,1);
--> size(v)
 ans  =
   2.   3.

--> // для фактического входного ND-мерного массива:
--> w = squeeze(ones(1,3,1,4))
 w  =
   1.   1.   1.   1.
   1.   1.   1.   1.
   1.   1.   1.   1.

--> size(w)
 ans  =
   3.   4.


--> // для четырёхмерного cell-массива
--> c = cat(4, {%t}, {%pi}, {"abc"});
--> size(c)
 ans  =
   1.   1.   1.   3.

--> x = squeeze(c)
 x  =
  [1x1 boolean ]
  [1x1 constant]
  [1x1 string  ]

--> size(x)
 ans  =
   3.   1.
]]></screen>
    </refsection>
    <refsection role="see also">
        <title>Смотрите также</title>
        <simplelist type="inline">
            <member>
                <link linkend="matrix">matrix</link>
            </member>
            <member>
                <link linkend="hypermatrices">гиперматрицы</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
