Help check: validate the help files on compilation against a derivated docbook schema
[scilab.git] / scilab / modules / elementary_functions / help / en_US / matrixoperations / cumprod.xml
index 398b87b..7ffcf04 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry version="5.0-subset Scilab" xml:id="cumprod" xml:lang="en"
-          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">
+<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" version="5.0-subset Scilab" xml:id="cumprod" xml:lang="en">
   <info>
     <pubdate>$LastChangedDate$</pubdate>
   </info>
-
   <refnamediv>
     <refname>cumprod</refname>
-
     <refpurpose>cumulative product of array elements</refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-
-    <synopsis>y=cumprod(x)
-    y=cumprod(x,orientation)
-    y=cumprod(x,outtype)
-    y=cumprod(x,orientation,outtype)
-    </synopsis>
+    <synopsis>y=cumprod(x)</synopsis>
+    <synopsis>y=cumprod(x,orientation)</synopsis>
+    <synopsis>y=cumprod(x,outtype)</synopsis>
+    <synopsis>y=cumprod(x,orientation,outtype)</synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Arguments</title>
-
-    <variablelist>
-      <varlistentry>
-        <term>x</term>
-
-        <listitem>
-          <para>
+    <para>
+      <variablelist>
+        <varlistentry>
+          <term>x</term>
+          <listitem>
+            <para>
             an array of  reals, complex, booleans,  polynomials or
             rational fractions.
           </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>orientation</term>
-        <listitem>
-          <para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>orientation</term>
+          <listitem>
+            <para>
             it can be either </para>
             <itemizedlist>
               <listitem>
               <listitem>
                 <para>a number with positive integer value</para>
               </listitem>
-          </itemizedlist>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>outtype</term>
-        <listitem>
-          <para>
+            </itemizedlist>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>outtype</term>
+          <listitem>
+            <para>
             a string with possible values <literal>"native"</literal> or <literal>"double"</literal>. </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>y</term>
-
-        <listitem>
-          <para>scalar or array</para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>y</term>
+          <listitem>
+            <para>scalar or array</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </para>
   </refsection>
-
   <refsection>
     <title>Description</title>
-
     <para>For an array <literal>x</literal>,
     <literal>y=cumprod(x)</literal> returns in the scalar <literal>y</literal> the
     cumulative product of all the elements of <literal>x</literal>.</para>
-
     <para><literal>y=cumprod(x,orientation)</literal> returns in
     <literal>y</literal> the cumulative product of <literal>x</literal> along the
     dimension given by <literal>orientation</literal>:</para>
-
     <itemizedlist>
- <listitem>
+      <listitem>
         <para>if <literal>orientation</literal> is equal to 1 or "r" then</para>
-        <para><latex> <![CDATA[ y(\mathbf{l},j) = \prod_{\mathbf{i}=1}^l x(\mathbf{i},j)]]> </latex></para> 
-        <para>or </para> 
-        <para><latex> <![CDATA[ y(\mathbf{l},j,k,\ldots) = \prod_{\mathbf{i}=1}^l x(\mathbf{i},j,k,\ldots)]]> </latex> </para>
+        <para>
+          <latex><![CDATA[ y(\mathbf{l},j) = \prod_{\mathbf{i}=1}^l x(\mathbf{i},j)]]></latex>
+        </para>
+        <para>or </para>
+        <para>
+          <latex><![CDATA[ y(\mathbf{l},j,k,\ldots) = \prod_{\mathbf{i}=1}^l x(\mathbf{i},j,k,\ldots)]]></latex>
+        </para>
       </listitem>
       <listitem>
         <para>Si <literal>orientation</literal>  est égal à  2 ou "c" alors:</para>
-        <para><latex><![CDATA[ y(i,\mathbf{l}) = \prod_{\mathbf{j}=1}^l x(i,{\mathbf{j})]]> </latex></para> 
-        <para> or </para> 
-        <para><latex><![CDATA[ y(i,\mathbf{l},k,\ldots) = \prod_{\mathbf{j}=1}^l x(i,\mathbf{j},k,\ldots)]]> </latex> </para>
+        <para>
+          <latex><![CDATA[ y(i,\mathbf{l}) = \prod_{\mathbf{j}=1}^l x(i,{\mathbf{j})]]></latex>
+        </para>
+        <para> or </para>
+        <para>
+          <latex><![CDATA[ y(i,\mathbf{l},k,\ldots) = \prod_{\mathbf{j}=1}^l x(i,\mathbf{j},k,\ldots)]]></latex>
+        </para>
       </listitem>
       <listitem>
         <para>if <literal>orientation</literal> is equal to n  then</para>
-        <para><latex><![CDATA[ y(i_1,\ldots,i_{n-1},\mathbf{l},i_{n+1},\ldots) = \prod_{\mathbf{i_n}=1}^l x(i_1,\ldots,i_{n-1},\mathbf{i_n},i_{n+1},\ldots)]]> </latex> </para>
+        <para>
+          <latex><![CDATA[ y(i_1,\ldots,i_{n-1},\mathbf{l},i_{n+1},\ldots) = \prod_{\mathbf{i_n}=1}^l x(i_1,\ldots,i_{n-1},\mathbf{i_n},i_{n+1},\ldots)]]></latex>
+        </para>
       </listitem>
       <listitem>
         <para><literal>y=cumprod(x,"*")</literal> is equivalent to <literal>y=cumprod(x)</literal> </para>
          Matlab compatibility.</para>
       </listitem>
     </itemizedlist>
-
-    <para></para>
+    <para/>
     <para>The <literal>outtype</literal>  argument rules the way the product is done:</para>
     <itemizedlist>
       <listitem>
         <para>For arrays of integers,</para>
         <para> if <literal>outtype="native"</literal> the evaluation is done using integer
         computations (modulo 2^b, where b is the number of bits used),</para>
-         <para> if <literal>outtype="double"</literal> the evaluation is done using floating point
+        <para> if <literal>outtype="double"</literal> the evaluation is done using floating point
         computations.</para>
         <para>The default value is <literal>outtype="native"</literal>.</para>
       </listitem>
         <para>For arrays of booleans,</para>
         <para> if <literal>outtype="native"</literal> the evaluation is done using boolean
         computations ( + is replaced by |),</para>
-         <para> if <literal>outtype="double"</literal> the evaluation is done using floating point
+        <para> if <literal>outtype="double"</literal> the evaluation is done using floating point
         computations (%t values are replaced by 1 and %f values by 0).</para>
-         <para>The default value is <literal>outtype="double"</literal>.</para>
+        <para>The default value is <literal>outtype="double"</literal>.</para>
       </listitem>
-
     </itemizedlist>
   </refsection>
-
   <refsection>
     <title>Remark</title>
-    <para>This function applies, with identical rules to <link
-    linkend="sparse">sparse matrices</link> and <link
-    linkend="hypermat">hypermatrices</link>.</para>
+    <para>This function applies, with identical rules to <link linkend="sparse">sparse matrices</link> and <link linkend="hypermat">hypermatrices</link>.</para>
   </refsection>
-
   <refsection>
     <title>Examples</title>
-
     <programlisting role="example"><![CDATA[ 
 A=[1,2;3,4];
 cumprod(A)
@@ -183,12 +168,15 @@ cumprod(B) //evaluation in float
 cumprod(B,"native") //similar to or(B)
  ]]></programlisting>
   </refsection>
-
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
-      <member><link linkend="prod">prod</link></member>
-      <member><link linkend="cumsum">cumsum</link></member>
+      <member>
+        <link linkend="prod">prod</link>
+      </member>
+      <member>
+        <link linkend="cumsum">cumsum</link>
+      </member>
     </simplelist>
   </refsection>
 </refentry>