home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fb.zip / octave / SCRIPTS.ZIP / scripts / statistics / base / std.m < prev    next >
Encoding:
Text File  |  1999-11-20  |  1.8 KB  |  67 lines
  1. ## Copyright (C) 1996, 1997 John W. Eaton
  2. ##
  3. ## This file is part of Octave.
  4. ##
  5. ## Octave is free software; you can redistribute it and/or modify it
  6. ## under the terms of the GNU General Public License as published by
  7. ## the Free Software Foundation; either version 2, or (at your option)
  8. ## any later version.
  9. ##
  10. ## Octave is distributed in the hope that it will be useful, but
  11. ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12. ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13. ## General Public License for more details.
  14. ##
  15. ## You should have received a copy of the GNU General Public License
  16. ## along with Octave; see the file COPYING.  If not, write to the Free
  17. ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  18. ## 02111-1307, USA.
  19.  
  20. ## -*- texinfo -*-
  21. ## @deftypefn {Function File} {} std (@var{x})
  22. ## If @var{x} is a vector, compute the standard deviation of the elements
  23. ## of @var{x}.
  24. ## @iftex
  25. ## @tex
  26. ## $$
  27. ## {\rm std} (x) = \sigma (x) = \sqrt{{\sum_{i=1}^N (x_i - \bar{x}) \over N - 1}}
  28. ## $$
  29. ## @end tex
  30. ## @end iftex
  31. ## @ifinfo
  32. ## 
  33. ## @example
  34. ## @group
  35. ## std (x) = sqrt (sumsq (x - mean (x)) / (n - 1))
  36. ## @end group
  37. ## @end example
  38. ## @end ifinfo
  39. ## If @var{x} is a matrix, compute the standard deviation for
  40. ## each column and return them in a row vector.
  41. ## @end deftypefn
  42.  
  43. ## See also: mean, median
  44.  
  45. ## Author: jwe
  46.  
  47. function retval = std (a)
  48.  
  49.   if (nargin != 1)
  50.     usage ("std (a)");
  51.   endif
  52.  
  53.   nr = rows (a);
  54.   nc = columns (a);
  55.   if (nc == 1 && nr == 1)
  56.     retval = 0;
  57.   elseif (nc == 1 || nr == 1)
  58.     n = length (a);
  59.     retval = sqrt (sumsq (a - mean (a)) / (n - 1));
  60.   elseif (nr > 1 && nc > 0)
  61.     retval = sqrt (sumsq (a - ones (nr, 1) * mean (a)) / (nr - 1));
  62.   else
  63.     error ("std: invalid matrix argument");
  64.   endif
  65.  
  66. endfunction
  67.