← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/eng/statistics/st_deviation.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/eng/statistics/st_deviation.xml
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>st_deviation</TITLE>
 
6
  <TYPE>Scilab Function</TYPE>
 
7
  <DATE>Januray 1998</DATE>
 
8
  <SHORT_DESCRIPTION name="st_deviation"> standard deviation (row or
 
9
    column-wise) of vector/matrix entries</SHORT_DESCRIPTION>
 
10
  <SHORT_DESCRIPTION name="stdev"> standard deviation (row or column-wise) of vector/matrix entries</SHORT_DESCRIPTION>
 
11
  <CALLING_SEQUENCE>
 
12
    <CALLING_SEQUENCE_ITEM>y=st_deviation(x)  </CALLING_SEQUENCE_ITEM>
 
13
    <CALLING_SEQUENCE_ITEM>y=st_deviation(x,'r')  </CALLING_SEQUENCE_ITEM>
 
14
    <CALLING_SEQUENCE_ITEM>y=st_deviation(x,'c')  </CALLING_SEQUENCE_ITEM>
 
15
    <CALLING_SEQUENCE_ITEM>y=stdev(x)  </CALLING_SEQUENCE_ITEM>
 
16
    <CALLING_SEQUENCE_ITEM>y=stdev(x,'r')  </CALLING_SEQUENCE_ITEM>
 
17
    <CALLING_SEQUENCE_ITEM>y=stdev(x,'c')  </CALLING_SEQUENCE_ITEM>
 
18
  </CALLING_SEQUENCE>
 
19
  <PARAM>
 
20
    <PARAM_INDENT>
 
21
      <PARAM_ITEM>
 
22
        <PARAM_NAME>x</PARAM_NAME>
 
23
        <PARAM_DESCRIPTION>
 
24
          <SP>: real vector or matrix</SP>
 
25
        </PARAM_DESCRIPTION>
 
26
      </PARAM_ITEM>
 
27
      <PARAM_ITEM>
 
28
        <PARAM_NAME>y</PARAM_NAME>
 
29
        <PARAM_DESCRIPTION>
 
30
          <SP>: scalar or vector</SP>
 
31
        </PARAM_DESCRIPTION>
 
32
      </PARAM_ITEM>
 
33
    </PARAM_INDENT>
 
34
  </PARAM>
 
35
  <DESCRIPTION>
 
36
    <P>
 
37
    st_deviation computes the &quot;sample&quot; standard deviation, that
 
38
    is, it is normalized by N-1, where N is the sequence length.</P>
 
39
    <P>
 
40
    For a vector or a matrix <VERB>x</VERB>, <VERB>y=st_deviation(x)</VERB>  returns in the
 
41
    scalar <VERB>y</VERB> the standard deviation of all the entries of <VERB>x</VERB>.</P>
 
42
    <P><VERB>y=st_deviation(x,'r')</VERB> (or, equivalently,
 
43
    <VERB>y=st_deviation(x,1)</VERB>) is the rowwise standard deviation. It returns in each 
 
44
    entry of the column vector <VERB>y</VERB> the standard deviation of each row of <VERB>x</VERB>.</P>
 
45
    <P><VERB>y=st_deviation(x,'c')</VERB> (or, equivalently, <VERB>y=st_deviation(x,2)</VERB>) is the columnwise st_deviation. It returns in each entry of the row vector 
 
46
    <VERB>y</VERB> the standard deviation of each column  of <VERB>x</VERB>.</P>
 
47
  </DESCRIPTION>
 
48
  <EXAMPLE>
 
49
<![CDATA[
 
50
A=[1,2,10;7,7.1,7.01];
 
51
st_deviation(A)
 
52
st_deviation(A,'r')
 
53
st_deviation(A,'c')
 
54
 ]]>
 
55
  </EXAMPLE>
 
56
  <SEE_ALSO>
 
57
    <SEE_ALSO_ITEM>
 
58
      <LINK>sum</LINK>
 
59
    </SEE_ALSO_ITEM>
 
60
    <SEE_ALSO_ITEM>
 
61
      <LINK>median</LINK>
 
62
    </SEE_ALSO_ITEM>
 
63
    <SEE_ALSO_ITEM>
 
64
      <LINK>mean</LINK>
 
65
    </SEE_ALSO_ITEM>
 
66
    <SEE_ALSO_ITEM>
 
67
      <LINK>nanstdev</LINK>
 
68
    </SEE_ALSO_ITEM>
 
69
    <SEE_ALSO_ITEM>
 
70
      <LINK>stdevf</LINK>
 
71
    </SEE_ALSO_ITEM>
 
72
  </SEE_ALSO>
 
73
</MAN>