← 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/descriptive_statistics/stdevf.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/descriptive_statistics/stdevf.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="stdevf">
14
 
  <refnamediv>
15
 
    <refname>stdevf</refname>
16
 
    <refpurpose> standard deviation</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>s=stdevf(x,fre)
21
 
      s=stdevf(x,fre,'r') or s=stdevf(x,fre,1)
22
 
      s=stdevf(x,fre,'c') or s=stdevf(x,fre,2)
23
 
    </synopsis>
24
 
  </refsynopsisdiv>
25
 
  <refsection>
26
 
    <title>Arguments</title>
27
 
    <variablelist>
28
 
      <varlistentry>
29
 
        <term>x</term>
30
 
        <listitem>
31
 
          <para>real or complex vector or matrix</para>
32
 
        </listitem>
33
 
      </varlistentry>
34
 
      <varlistentry>
35
 
        <term>fre</term>
36
 
        <listitem>
37
 
          <para>real or complex vector or matrix</para>
38
 
        </listitem>
39
 
      </varlistentry>
40
 
    </variablelist>
41
 
  </refsection>
42
 
  <refsection>
43
 
    <title>Description</title>
44
 
    <para>
45
 
      This function   computes the standard  deviation  of the
46
 
      values  of a vector  or matrix <literal>   x</literal>, each of them
47
 
      counted with  a  frequency  given  by the  corresponding
48
 
      values of the  integer vector or matrix  <literal> fre</literal> who
49
 
      has the same type of <literal> x</literal>.
50
 
    </para>
51
 
    <para>
52
 
      For  a vector or matrix  <literal>  x</literal>, s=stdevf(x,fre) (or
53
 
      <literal> s=stdevf(x,fre,'*') </literal>  returns in scalar <literal> s</literal>
54
 
      the standard deviation of all the entries  of <literal> x</literal>,
55
 
      each value  counted  with the multiplicity  indicated by
56
 
      the corresponding value of <literal> fre</literal>.
57
 
    </para>
58
 
    <para>
59
 
      <literal>s=stdevf(x,fre,'r')</literal>   (or,     equivalently,   
60
 
      <literal>s=stdevf(x,fre,1)</literal>) returns in each  entry of  the row
61
 
      vector  <literal> s</literal>  of type  1xsize(x,'c')  the standard
62
 
      deviation of each column of <literal> x</literal>, each value counted
63
 
      with  the multiplicity  indicated  by the  corresponding
64
 
      value of <literal> fre</literal>.
65
 
    </para>
66
 
    <para>
67
 
      <literal>s=stdevf(x,fre,'c')</literal>    (or,   equivalently,    
68
 
      <literal> s=stdevf(x,fre,2)</literal>)  returns   in each  entry  of  the
69
 
      column vector  <literal>  s</literal>   of type  size(x,'c')x1   the
70
 
      standard  deviation of each row  of <literal> x</literal>, each value
71
 
      counted    with the  multiplicity    indicated   by  the
72
 
      corresponding value of <literal> fre</literal>.
73
 
    </para>
74
 
  </refsection>
75
 
  <refsection>
76
 
    <title>Examples</title>
77
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>stdevf</refname>
 
16
        <refpurpose> standard deviation</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>s=stdevf(x,fre)
 
21
            s=stdevf(x,fre,'r') or s=stdevf(x,fre,1)
 
22
            s=stdevf(x,fre,'c') or s=stdevf(x,fre,2)
 
23
        </synopsis>
 
24
    </refsynopsisdiv>
 
25
    <refsection>
 
26
        <title>Arguments</title>
 
27
        <variablelist>
 
28
            <varlistentry>
 
29
                <term>x</term>
 
30
                <listitem>
 
31
                    <para>real or complex vector or matrix</para>
 
32
                </listitem>
 
33
            </varlistentry>
 
34
            <varlistentry>
 
35
                <term>fre</term>
 
36
                <listitem>
 
37
                    <para>real or complex vector or matrix</para>
 
38
                </listitem>
 
39
            </varlistentry>
 
40
        </variablelist>
 
41
    </refsection>
 
42
    <refsection>
 
43
        <title>Description</title>
 
44
        <para>
 
45
            This function   computes the standard  deviation  of the
 
46
            values  of a vector  or matrix <literal>   x</literal>, each of them
 
47
            counted with  a  frequency  given  by the  corresponding
 
48
            values of the  integer vector or matrix  <literal> fre</literal> who
 
49
            has the same type of <literal> x</literal>.
 
50
        </para>
 
51
        <para>
 
52
            For  a vector or matrix  <literal>  x</literal>, s=stdevf(x,fre) (or
 
53
            <literal> s=stdevf(x,fre,'*') </literal>  returns in scalar <literal> s</literal>
 
54
            the standard deviation of all the entries  of <literal> x</literal>,
 
55
            each value  counted  with the multiplicity  indicated by
 
56
            the corresponding value of <literal> fre</literal>.
 
57
        </para>
 
58
        <para>
 
59
            <literal>s=stdevf(x,fre,'r')</literal>   (or,     equivalently,   
 
60
            <literal>s=stdevf(x,fre,1)</literal>) returns in each  entry of  the row
 
61
            vector  <literal> s</literal>  of type  1xsize(x,'c')  the standard
 
62
            deviation of each column of <literal> x</literal>, each value counted
 
63
            with  the multiplicity  indicated  by the  corresponding
 
64
            value of <literal> fre</literal>.
 
65
        </para>
 
66
        <para>
 
67
            <literal>s=stdevf(x,fre,'c')</literal>    (or,   equivalently,    
 
68
            <literal> s=stdevf(x,fre,2)</literal>)  returns   in each  entry  of  the
 
69
            column vector  <literal>  s</literal>   of type  size(x,'c')x1   the
 
70
            standard  deviation of each row  of <literal> x</literal>, each value
 
71
            counted    with the  multiplicity    indicated   by  the
 
72
            corresponding value of <literal> fre</literal>.
 
73
        </para>
 
74
    </refsection>
 
75
    <refsection>
 
76
        <title>Examples</title>
 
77
        <programlisting role="example"><![CDATA[ 
78
78
x=[0.2113249 0.0002211 0.6653811;0.7560439 0.9546254 0.6283918]
79
79
fre=[1 2 3;3 4 3]
80
80
m=stdevf(x,fre)
81
81
m=stdevf(x,fre,'r')
82
82
m=stdevf(x,fre,'c')
83
83
 ]]></programlisting>
84
 
  </refsection>
85
 
  <refsection>
86
 
    <title>Bibliography</title>
87
 
    <para>
88
 
      Wonacott, T.H. &amp; Wonacott, R.J.; Introductory Statistics, fifth edition, J.Wiley &amp; Sons, 1990.
89
 
    </para>
90
 
  </refsection>
 
84
    </refsection>
 
85
    <refsection>
 
86
        <title>Bibliography</title>
 
87
        <para>
 
88
            Wonacott, T.H. &amp; Wonacott, R.J.; Introductory Statistics, fifth edition, J.Wiley &amp; Sons, 1990.
 
89
        </para>
 
90
    </refsection>
91
91
</refentry>