← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/statistics/help/en_US/data_missing_values/nancumsum.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/statistics/help/en_US/data_missing_values/nancumsum.xml
11
11
 *
12
12
 -->
13
13
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="nancumsum">
14
 
  <refnamediv>
15
 
    <refname>nancumsum</refname>
16
 
    <refpurpose>  Thos function returns
17
 
      the cumulative sum of the values of a matrix
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsynopsisdiv>
21
 
    <title>Calling Sequence</title>
22
 
    <synopsis>s = nancumsum(x,orient)</synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>x</term>
29
 
        <listitem>
30
 
          <para>x is a numerical vector or matrix.</para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
      <varlistentry>
34
 
        <term>orient</term>
35
 
        <listitem>
36
 
          <para>is an optional parameter. The possible values are
37
 
            '*', 1, 2, 'r' or 'c'.
38
 
          </para>
39
 
        </listitem>
40
 
      </varlistentry>
41
 
      <varlistentry>
42
 
        <term>s</term>
43
 
        <listitem>
44
 
          <para>numerical scalar or vector. It contains the cumulative
45
 
            sum of the values of x, ignoring the NAN's.
46
 
          </para>
47
 
        </listitem>
48
 
      </varlistentry>
49
 
    </variablelist>
50
 
  </refsection>
51
 
  <refsection>
52
 
    <title>Description</title>
53
 
    <para>
54
 
      This function returns in scalar or vector s the cumulative
55
 
      sum  of the  values (ignoring  the  NANs) of  a vector  or
56
 
      matrix (real or complex) x.
57
 
    </para>
58
 
    <para>
59
 
      This function  for a vector or a  matrix x, s=nancumsum(x)
60
 
      (or, equivalently  s=nancumsum(x,'*') returns in  scalar s
61
 
      the cumulative sum (ignoring  the NANs) of all the entries
62
 
      of x taken columnwise.
63
 
    </para>
64
 
    <para>
65
 
      s=nancumsum(x,'r')  (or,  equivalently,  s=nancumsum(x,1))
66
 
      returns in  the cols(x) sized vector s  the cumulative sum
67
 
      (ignoring    the    NANs)    of    the    rows    of    x:
68
 
      s(:,i)=nancumsum(x(:,i))
69
 
    </para>
70
 
    <para>
71
 
      s=nancumsum(x,'c')  (or,  equivalently,  s=nancumsum(x,2))
72
 
      returns in  the rows(x) sized vector s  the cumulative sum
73
 
      (ignoring     NANs)    of     the     columns    of     x:
74
 
      s(i,:)=nancumsum(x(i,:))
75
 
    </para>
76
 
    <para>
77
 
      For the  last two cases,  if a row  or column is  in whole
78
 
      composed of NAN, the corresponding place of s will contain
79
 
      a NAN.
80
 
    </para>
81
 
  </refsection>
82
 
  <refsection>
83
 
    <title>Examples</title>
84
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>nancumsum</refname>
 
16
        <refpurpose>  Thos function returns
 
17
            the cumulative sum of the values of a matrix
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsynopsisdiv>
 
21
        <title>Calling Sequence</title>
 
22
        <synopsis>s = nancumsum(x,orient)</synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>x</term>
 
29
                <listitem>
 
30
                    <para>x is a numerical vector or matrix.</para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
            <varlistentry>
 
34
                <term>orient</term>
 
35
                <listitem>
 
36
                    <para>is an optional parameter. The possible values are
 
37
                        '*', 1, 2, 'r' or 'c'.
 
38
                    </para>
 
39
                </listitem>
 
40
            </varlistentry>
 
41
            <varlistentry>
 
42
                <term>s</term>
 
43
                <listitem>
 
44
                    <para>numerical scalar or vector. It contains the cumulative
 
45
                        sum of the values of x, ignoring the NAN's.
 
46
                    </para>
 
47
                </listitem>
 
48
            </varlistentry>
 
49
        </variablelist>
 
50
    </refsection>
 
51
    <refsection>
 
52
        <title>Description</title>
 
53
        <para>
 
54
            This function returns in scalar or vector s the cumulative
 
55
            sum  of the  values (ignoring  the  NANs) of  a vector  or
 
56
            matrix (real or complex) x.
 
57
        </para>
 
58
        <para>
 
59
            This function  for a vector or a  matrix x, s=nancumsum(x)
 
60
            (or, equivalently  s=nancumsum(x,'*') returns in  scalar s
 
61
            the cumulative sum (ignoring  the NANs) of all the entries
 
62
            of x taken columnwise.
 
63
        </para>
 
64
        <para>
 
65
            s=nancumsum(x,'r')  (or,  equivalently,  s=nancumsum(x,1))
 
66
            returns in  the cols(x) sized vector s  the cumulative sum
 
67
            (ignoring    the    NANs)    of    the    rows    of    x:
 
68
            s(:,i)=nancumsum(x(:,i))
 
69
        </para>
 
70
        <para>
 
71
            s=nancumsum(x,'c')  (or,  equivalently,  s=nancumsum(x,2))
 
72
            returns in  the rows(x) sized vector s  the cumulative sum
 
73
            (ignoring     NANs)    of     the     columns    of     x:
 
74
            s(i,:)=nancumsum(x(i,:))
 
75
        </para>
 
76
        <para>
 
77
            For the  last two cases,  if a row  or column is  in whole
 
78
            composed of NAN, the corresponding place of s will contain
 
79
            a NAN.
 
80
        </para>
 
81
    </refsection>
 
82
    <refsection>
 
83
        <title>Examples</title>
 
84
        <programlisting role="example"><![CDATA[ 
85
85
a=[1 2 3;4 5 6]
86
86
s=nancumsum(a)
87
87
s=nancumsum(a,'r')
88
88
s=nancumsum(a,'c')
89
89
 ]]></programlisting>
90
 
  </refsection>
91
 
  <refsection role="see also">
92
 
    <title>See Also</title>
93
 
    <simplelist type="inline">
94
 
      <member>
95
 
        <link linkend="nansum">nansum</link>
96
 
      </member>
97
 
      <member>
98
 
        <link linkend="cumsum">cumsum</link>
99
 
      </member>
100
 
    </simplelist>
101
 
  </refsection>
 
90
    </refsection>
 
91
    <refsection role="see also">
 
92
        <title>See Also</title>
 
93
        <simplelist type="inline">
 
94
            <member>
 
95
                <link linkend="nansum">nansum</link>
 
96
            </member>
 
97
            <member>
 
98
                <link linkend="cumsum">cumsum</link>
 
99
            </member>
 
100
        </simplelist>
 
101
    </refsection>
102
102
</refentry>