<?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" xmlns:scilab="http://www.scilab.org"
          xml:id="sum" xml:lang="ru">
    <refnamediv>
        <refname>sum</refname>
        <refpurpose>сумма элементов массива</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Синтаксис</title>
        <synopsis>
            y = sum(x)
            y = sum(x, outtype)
            y = sum(x, orientation)
            y = sum(x, orientation, outtype)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Аргументы</title>
        <variablelist>
            <varlistentry>
                <term>x</term>
                <listitem>
                    Массив логических (плотных или разреженных), закодированных целых чисел,
                    действительных или комплексных чисел (плотных или разреженных),
                    полиномов или рациональных чисел.
                    <para/>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>orientation</term>
                <listitem>
                    (ориентация) может быть или
                    <itemizedlist>
                        <listitem>
                            строкой с возможными значениями <literal>"*"</literal> ("естественное"),
                            <literal>"r"</literal>, <literal>"c"</literal> или  <literal>"m"</literal>
                            <para/>
                        </listitem>
                        <listitem>
                            или целым положительным числом
                            <para/>
                        </listitem>
                    </itemizedlist>
                    <para/>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>outtype</term>
                <listitem>
                    строка с возможными значениями <literal>"native"</literal> ("естественное")
                    или <literal>"double"</literal>.
                    <para/>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>y</term>
                <listitem>
                    скаляр или массив
                    <para/>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Описание</title>
        <para>
            Для массива <literal>x</literal> <literal>y=sum(x)</literal> возвращает скаляр
            <literal>y</literal>, являющийся суммой всех элементов <literal>x</literal>.
        </para>
        <para>
            <literal>y=sum(x,orientation)</literal> возвращает в <literal>y</literal> сумму
            <literal>x</literal> вдоль размерности, заданной  <literal>orientation</literal>:
        </para>
        <itemizedlist>
            <listitem>
                <para>
                    если <literal>orientation</literal> равна 1 или "r", то
                </para>
                <para>
                    <latex><![CDATA[{ y(\mathbf{1},j) = \sum_{\mathbf{i}} x(\mathbf{i},j)}]]></latex>
                </para>
                <para>или </para>
                <para>
                    <latex><![CDATA[ y(\mathbf{1},j,k,\ldots) = \sum_{\mathbf{i}} x(\mathbf{i},j,k,\ldots)]]></latex>
                </para>
            </listitem>
            <listitem>
                <para>
                    если <literal>orientation</literal> равна 2 или "c", то:
                </para>
                <para>
                    <latex><![CDATA[ y(i,\mathbf{1}) = \sum_{\mathbf{j}} x(i,\mathbf{j})]]></latex>
                </para>
                <para>или </para>
                <para>
                    <latex><![CDATA[ y(i,\mathbf{1},k,\ldots) = \sum_{j} x(i,\mathbf{j},k,\ldots)]]></latex>
                </para>
            </listitem>
            <listitem>
                <para>
                    если <literal>orientation</literal> равна n, то
                </para>
                <para>
                    <latex><![CDATA[ y(i_1,\ldots,i_{n-1},\mathbf{1},i_{n+1},\ldots) = \sum_{\mathbf{i_n}} x(i_1,\ldots,i_{n-1},\mathbf{i_n},i_{n+1},\ldots)]]></latex>
                </para>
            </listitem>
            <listitem>
                <para>
                    <literal>y=sum(x,"*")</literal> эквивалентно <literal>y=sum(x)</literal>
                </para>
            </listitem>
            <listitem>
                <para>
                    <literal>y=sum(x,"m")</literal> эквивалентно
                    <literal>y=sum(x,orientation)</literal>, где <literal>orientation</literal>
                    является индексом первой размерности <literal>x</literal>, которая больше 1.
                </para>
            </listitem>
        </itemizedlist>
        <para>
            Аргумент <literal>outtype</literal> управляет способом, которым выполняется
            суммирование:
        </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>
        <note>
            Эта функция применяется с аналогичными правилами к <link linkend="sparse">разряжённым
                матрицам
            </link>
            .
        </note>
    </refsection>
    <refsection>
        <title>Примеры</title>
        <programlisting role="example"><![CDATA[
A=[1,2;3,4];
sum(A)
sum(A,1)

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

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

B=[%t %t %f %f];
sum(B) //вычисление с плавающей запятой
sum(B,"native") //аналогично or(B)
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Смотрите также</title>
        <simplelist type="inline">
            <member>
                <link linkend="plus">plus</link>
            </member>
            <member>
                <link linkend="cumsum">cumsum</link>
            </member>
            <member>
                <link linkend="prod">prod</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
