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

« back to all changes in this revision

Viewing changes to man/elementary/st_deviation.cat

  • 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
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
st_deviation        Scilab Group        Scilab Function        st_deviation
2
 
NAME
3
 
   st_deviation - standard deviation (row or column-wise) of vector/matrix
4
 
  entries
5
 
  
6
 
CALLING SEQUENCE
7
 
 y=st_deviation(x)
8
 
 y=st_deviation(x,'r')
9
 
 y=st_deviation(x,'c')
10
 
PARAMETERS
11
 
 x          : real vector or matrix 
12
 
            
13
 
 y          : scalar or vector
14
 
            
15
 
DESCRIPTION
16
 
   st_deviation computes the "sample" standard deviation, that is, it is
17
 
  normalized by N-1, where N is the sequence length.
18
 
  
19
 
   For a vector or a matrix x, y=st_deviation(x)  returns in the scalar y
20
 
  the standard deviation of all the entries of x.
21
 
  
22
 
   y=st_deviation(x,'r') (or, equivalently, y=st_deviation(x,1)) is the
23
 
  rowwise standard deviation. It returns in each  entry of the column
24
 
  vector y the standard deviation of each row of x.
25
 
  
26
 
    y=st_deviation(x,'c') (or, equivalently, y=st_deviation(x,2)) is the
27
 
  columnwise st_deviation. It returns in each entry of the row vector  y
28
 
  the standard deviation of each column  of x.
29
 
  
30
 
EXAMPLE
31
 
 A=[1,2,10;7,7.1,7.01];
32
 
 st_deviation(A)
33
 
 st_deviation(A,'r')
34
 
 st_deviation(A,'c')
35
 
SEE ALSO
36
 
   sum, median, mean
37