<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2010 - Serge Steer - 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:ns5="http://www.w3.org/1999/xhtml"
          xmlns:db="http://docbook.org/ns/docbook" xml:id="cumsum" xml:lang="ru">

    <refnamediv>
        <refname>cumsum</refname>
        <refpurpose>суммирование элементов массива с накоплением</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
        <title>Синтаксис</title>
        <synopsis>
            y = cumsum(x)
            y = cumsum(x, outtype)
            y = cumsum(x, orientation)
            y = cumsum(x, orientation, outtype)
        </synopsis>
    </refsynopsisdiv>

    <refsection role="parameters">
        <title>Аргументы</title>
        <variablelist>
            <varlistentry>
                <term>x</term>
                <listitem>
                    <para>
                        массив вещественных, комплексных, логических значений, а также полиномов или
                        рациональных дробей.
                        Гиперматрицы или разрежённые логические или числовые матрицы так же поддерживаются.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>orientation</term>
                <listitem>
                    <para>
                        ориентация, она может быть:
                    </para>
                    <itemizedlist>
                        <listitem>
                            <para>
                                строкой с возможными значениями: <literal>"*"</literal>,
                                <literal>"r"</literal>, <literal>"c"</literal> или  <literal>"m"</literal>
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                              или положительное целое число <literal>1 ≤ orientation ≤ ndims(x)</literal>:
                              индекс размерности, вдоль которой сумма с накоплением должна быть вычислена.
                              1 и "r", и 2 и "c" эквивалентны.
                            </para>
                        </listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>outtype</term>
                <listitem>
                    <para>
                        тип на выходе: строка с возможными значениями:
                        <literal>"native"</literal> или <literal>"double"</literal>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>y</term>
                <listitem>
                    <para>Array of size equal to that of <varname>x</varname>.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>

    <refsection role="description">
        <title>Описание</title>
        <para>
            <emphasis role="bold">y = cumsum(x)</emphasis> computes and provides the partial
            cumulative sums <literal>y(i)=sum(x(1:i))</literal>, <emphasis role="italic">i.e.</emphasis>:
        </para>
        <para>
            <latex alt="y(i) = ∑u=1→i x(u)"><![CDATA[ y(i) = \sum_{u=1}^i x(u)]]></latex>
        </para>
        <para>
            <emphasis role="bold">y = cumsum(x, orientation)</emphasis> computes and returns the partial
            cumulative sums of <term>x</term> along the dimension given by <term>orientation</term>:
        </para>
        <itemizedlist>
            <listitem>
                <para>
                    если <term>orientation</term> равна 1 или "r", то:
                </para>
                <para>
                    <latex alt="y(i,j) = ∑u=1→i x(u,j)"><![CDATA[
                        y(\mathbf{i},j) = \sum_{u=1}^{\mathbf{i}} x(\mathbf{u},j)   ]]>
                    </latex>, или для N-мерного массива :
                </para>
                <para>
                    <latex alt="y(i,j,k,…) = ∑u=1→i x(u,j,k,…)"><![CDATA[
                        y(\mathbf{i},j,k,\ldots) = \sum_{u=1}^{\mathbf{i}} x(\mathbf{u},j,k,\ldots)  ]]>
                    </latex>
                </para>
            </listitem>
            <listitem>
                <para>
                    если <term>orientation</term> равна 2 или "c", то:
                </para>
                <para>
                    <latex alt="y(i,j) = ∑u=1→j x(i,u)"><![CDATA[
                        y(i,\mathbf{j}) = \sum_{u=1}^{\mathbf{j}} x(i,{\mathbf{u})  ]]>
                    </latex>, или для N-мерного массива :
                </para>
                <para>
                    <latex alt="y(i,j,k,…) = ∑u=1→j x(i,u,k,…)"><![CDATA[
                        y(i,\mathbf{j},k,\ldots) = \sum_{u=1}^{\mathbf{j}} x(i,\mathbf{u},k,\ldots) ]]>
                    </latex>
                </para>
            </listitem>
            <listitem>
                <para>
                    если <term>orientation</term> равна n, то:
                </para>
                <para>
                    <latex alt="y(i₁,…,iₙ₋₁, iₙ,iₙ₊₁,…) = ∑u=1…iₙ  x(i₁,…,iₙ₋₁, u,iₙ₊₁,…)"><![CDATA[
                        y(i_1,\ldots,i_{n-1},\mathbf{i_{n}},i_{n+1},\ldots) =
                        \sum_{u=1}^{\mathbf{i_n}} x(i_1,\ldots,i_{n-1},\mathbf{u},i_{n+1},\ldots) ]]>
                    </latex>
                </para>
            </listitem>
            <listitem>
                <para>
                    <emphasis role="bold">y = cumsum(x, "*")</emphasis> эквивалентно
                    <literal>y = cumsum(x)</literal>
                </para>
            </listitem>
            <listitem>
                <para>
                    <emphasis role="bold">y = cumsum(x, "m")</emphasis> эквивалентно
                    <literal>y = cumsum(x, orientation)</literal>, где <literal>orientation</literal>
                    является индексом первой размерности <literal>x</literal>, которая больше 1.
                    Эта опция используется для совместимости с Matlab'ом.
                </para>
            </listitem>
        </itemizedlist>
        <para/>
        <para>
            Аргумент <term>outtype</term> управляет способом, которым производится суммирование:
        </para>
        <itemizedlist>
            <listitem>
                <para>
                    Для массивов чисел с плавающей запятой, полиномов, рациональных дробей
                    вычисление всегда делается через вычисления с плавающей запятой.
                    Опции <literal>"double"</literal> и <literal>"native"</literal> ("естественное")
                    эквивалентны.
                </para>
            </listitem>
            <listitem>
                <para>Для массивов целых чисел:</para>
                <para>
                    если <literal>outtype="native"</literal> ("естественное"), то вычисление
                    делается через целочисленные вычисления (по модулю 2^b, где b - число
                    используемых битов);
                </para>
                <para>
                    если <literal>outtype="double"</literal>, то вычисление делается через вычисления
                    с плавающей запятой.
                </para>
                <para>
                    Значение по умолчанию <literal>outtype="native"</literal>.
                </para>
            </listitem>
            <listitem>
                <para>Для массивов логических значений:</para>
                <para>
                    если <literal>outtype="native"</literal> ("естественное"), то вычисления делаются
                    с помощью  булевой алгебры (+ заменяется на |),
                </para>
                <para>
                    если <literal>outtype="double"</literal>, то вычисление  делается через вычисления
                    с плавающей запятой (значения %t заменяются на 1, а значения %f - на 0).
                </para>
                <para>
                    Значение по умолчанию <literal>outtype="double"</literal>.
                </para>
            </listitem>
        </itemizedlist>
        <warning>
            Когда входная переменная <varname>x</varname> является разрежённой, пожалуйста, имейте ввиду,
            что плотность результата <varname>y</varname> будет почти всегда близка к 100%.
        </warning>
    </refsection>

    <refsection role="examples">
        <title>Примеры</title>
        <programlisting role="example"><![CDATA[
A = [1, 2 ; 3, 4];
cumsum(A)
cumsum(A,1)

I = uint8([2 95 103 ; 254 9 0])
cumsum(I)   // естественное вычисление
cumsum(I,"double")
cumsum(I,2,"double")

s = poly(0,"s");
P = [s, %i+s ; s^2, 1];
cumsum(P),
cumsum(P,2)

B = [%t %t %f %f];
cumsum(B)          // вычисление с плавающей запятой
cumsum(B,"native") // аналогично or(B)
 ]]></programlisting>
    </refsection>

    <refsection role="see also">
        <title>Смотрите также</title>
        <simplelist type="inline">
            <member>
                <link linkend="sum">sum</link>
            </member>
            <member>
                <link linkend="cumprod">cumprod</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
