octave_packages/statistics-1.1.3/harmmean.m

   1 ## Copyright (C) 2001 Paul Kienzle <pkienzle@users.sf.net>
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify it under
   4 ## the terms of the GNU General Public License as published by the Free Software
   5 ## Foundation; either version 3 of the License, or (at your option) any later
   6 ## version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but WITHOUT
   9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  11 ## details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License along with
  14 ## this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} harmmean (@var{x})
  18 ## @deftypefnx{Function File} harmmean (@var{x}, @var{dim})
  19 ## Compute the harmonic mean.
  20 ##
  21 ## This function does the same as @code{mean (x, "h")}.
  22 ##
  23 ## @seealso{mean}
  24 ## @end deftypefn
  25
  26 function a = harmmean(x, dim)
  27   if (nargin == 1)
  28     a = mean(x, "h");
  29   elseif (nargin == 2)
  30     a = mean(x, "h", dim);
  31   else
  32     print_usage;
  33   endif
  34 endfunction