<?xml version="1.0" encoding="UTF-8"?>

<!--
 * Scilab ( https://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: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="prod" xml:lang="ja">
    <refnamediv>
        <refname>prod</refname>
        <refpurpose>配列要素の積</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>呼び出し手順</title>
        <synopsis>y=prod(x)
            y=prod(x,orientation)
            y=prod(x,outtype)
            y=prod(x,orientation,outtype)
        </synopsis>
    </refsynopsisdiv>

    <refsection>

        <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>正の整数値</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>スカラーまたは配列</para>

                </listitem>

            </varlistentry>

        </variablelist>

    </refsection>

    <refsection>

        <title>説明</title>

        <para>

            配列<literal>x</literal>に関して,

            <literal>y=prod(x)</literal>はスカラー <literal>y</literal>に

            <literal>x</literal>の全要素の積を返します.

        </para>

        <para>

            <literal>y=prod(x,orientation)</literal> は

            <literal>orientation</literal>で指定された方向の

            <literal>x</literal>の積を<literal>y</literal>に返します:

        </para>


        <itemizedlist>

            <listitem>

                <para>

                    <literal>orientation</literal>が1または "r"の場合:

                </para>

                <para>

                    <latex><![CDATA[{ y(\mathbf{1},j) = \prod_{\mathbf{i}} x(\mathbf{i},j)}]]></latex>

                </para>

                <para>または </para>

                <para>

                    <latex><![CDATA[ y(\mathbf{1},j,k,\ldots) = \prod_{\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}) = \prod_{\mathbf{j}} x(i,\mathbf{j})]]></latex>

                </para>

                <para>または </para>

                <para>

                    <latex><![CDATA[ y(i,\mathbf{1},k,\ldots) = \prod_{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) = \prod_{\mathbf{i_n}} x(i_1,\ldots,i_{n-1},\mathbf{i_n},i_{n+1},\ldots)]]></latex>

                </para>

            </listitem>

            <listitem>

                <para>

                    <literal>y=prod(x,"*")</literal> は

                    <literal>y=prod(x)</literal> と等価です.

                </para>

            </listitem>

            <listitem>

                <para>

                    <literal>y=prod(x,"m")</literal> は

                    <literal>y=prod(x,orientation)</literal> と等価です.

                    ただし,<literal>orientation</literal> は

                    <literal>x</literal>の1より大きい最初の次元の添字です.

                </para>

            </listitem>

        </itemizedlist>

        <para/>

        <para>

            <literal>outtype</literal>引数は積算の動作を規定します:

        </para>

        <itemizedlist>

            <listitem>

                <para>

                    float, 多項式, 有理数の配列の場合,

                    評価は常に浮動小数点演算により行われます.

                    <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>の時,
                    評価は論理値演算(* は &amp;で置換されます)で行われます.
                </para>
                <para>
                    <literal>outtype="double"</literal>の時,
                    評価は浮動小数点演算(%t は1, %f は 0 で置換されます)
                    により行われます.
                </para>
                <para>
                    デフォルト値は,
                    <literal>outtype="double"</literal>です. このオプションは
                    Matlabとの互換性のために使用されます.
                </para>
            </listitem>
        </itemizedlist>
        <note>
            This function applies with identical rules to <link linkend="sparse">sparse matrices</link>.
        </note>

    </refsection>
    <refsection>
        <title>例</title>
        <programlisting role="example"><![CDATA[
A=[1,2;3,4];
prod(A)
prod(A,1)

I=uint8([2 95 103;254 9 0])
prod(I) //native evaluation
prod(I,"double")
prod(I,2,"double")

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

B=[%t %t %f %f];
prod(B) //evaluation in float
prod(B,"native") //similar to and(B)
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>参照</title>
        <simplelist type="inline">
            <member>
                <link linkend="cumprod">cumprod</link>
            </member>
            <member>
                <link linkend="sum">sum</link>
            </member>
        </simplelist>
    </refsection>
</refentry>

