Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / statistics-1.1.3 / harmmean.m

diff --git a/octave_packages/statistics-1.1.3/harmmean.m b/octave_packages/statistics-1.1.3/harmmean.m
new file mode 100644 (file)
index 0000000..fcbd45b
--- /dev/null
+++ b/octave_packages/statistics-1.1.3/harmmean.m
@@ -0,0 +1,34 @@
+## Copyright (C) 2001 Paul Kienzle <pkienzle@users.sf.net>
+##
+## This program is free software; you can redistribute it and/or modify it under
+## the terms of the GNU General Public License as published by the Free Software
+## Foundation; either version 3 of the License, or (at your option) any later
+## version.
+##
+## This program is distributed in the hope that it will be useful, but WITHOUT
+## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+## details.
+##
+## You should have received a copy of the GNU General Public License along with
+## this program; if not, see <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} harmmean (@var{x})
+## @deftypefnx{Function File} harmmean (@var{x}, @var{dim})
+## Compute the harmonic mean.
+##
+## This function does the same as @code{mean (x, "h")}.
+##
+## @seealso{mean}
+## @end deftypefn
+
+function a = harmmean(x, dim)
+  if (nargin == 1)
+    a = mean(x, "h");
+  elseif (nargin == 2)
+    a = mean(x, "h", dim);
+  else
+    print_usage;
+  endif
+endfunction