Mercurial > hg > octave-lyh

comparison scripts/statistics/base/std.m @ 10793:be55736a0783

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammarcheck the documentation from m-files.
author Rik <octave@nomad.inbox5.com>
date Sun, 18 Jul 2010 20:35:16 -0700
parents bb37822e9b82
children 693e22af08ae
comparison
equal deleted inserted replaced
10792:91342260063e 10793:be55736a0783
16 ## You should have received a copy of the GNU General Public License 16 ## You should have received a copy of the GNU General Public License
17 ## along with Octave; see the file COPYING. If not, see 17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>. 18 ## <http://www.gnu.org/licenses/>.
19 19
20 ## -*- texinfo -*- 20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {} std (@var{x}) 21 ## @deftypefn {Function File} {} std (@var{x})
22 ## @deftypefnx {Function File} {} std (@var{x}, @var{opt}) 22 ## @deftypefnx {Function File} {} std (@var{x}, @var{opt})
23 ## @deftypefnx {Function File} {} std (@var{x}, @var{opt}, @var{dim}) 23 ## @deftypefnx {Function File} {} std (@var{x}, @var{opt}, @var{dim})
24 ## If @var{x} is a vector, compute the standard deviation of the elements 24 ## If @var{x} is a vector, compute the standard deviation of the elements
25 ## of @var{x}. 25 ## of @var{x}.
26 ## @tex 26 ## @tex
38 ## @end example 38 ## @end example
39 ## @end ifnottex 39 ## @end ifnottex
40 ## If @var{x} is a matrix, compute the standard deviation for 40 ## If @var{x} is a matrix, compute the standard deviation for
41 ## each column and return them in a row vector. 41 ## each column and return them in a row vector.
42 ## 42 ##
43 ## The argument @var{opt} determines the type of normalization to use. Valid values 43 ## The argument @var{opt} determines the type of normalization to use. Valid
44 ## are 44 ## values are
45 ## 45 ##
46 ## @table @asis 46 ## @table @asis
47 ## @item 0: 47 ## @item 0:
48 ## normalizes with @math{N-1}, provides the square root of best unbiased estimator of 48 ## normalizes with @math{N-1}, provides the square root of best unbiased
49 ## the variance [default] 49 ## estimator of the variance [default]
50 ## @item 1: 50 ## @item 1:
51 ## normalizes with @math{N}, this provides the square root of the second moment around 51 ## normalizes with @math{N}, this provides the square root of the second
52 ## the mean 52 ## moment around the mean
53 ## @end table 53 ## @end table
54 ## 54 ##
55 ## The third argument @var{dim} determines the dimension along which the standard 55 ## The third argument @var{dim} determines the dimension along which the
56 ## standard
56 ## deviation is calculated. 57 ## deviation is calculated.
57 ## @seealso{mean, median} 58 ## @seealso{mean, median}
58 ## @end deftypefn 59 ## @end deftypefn
59 60
60 ## Author: jwe 61 ## Author: jwe