X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?p=CreaPhase.git;a=blobdiff_plain;f=octave_packages%2Fstatistics-1.1.3%2Fharmmean.m;fp=octave_packages%2Fstatistics-1.1.3%2Fharmmean.m;h=fcbd45bbbc0e83041abbd783899a42e673ec32c2;hp=0000000000000000000000000000000000000000;hb=c880e8788dfc484bf23ce13fa2787f2c6bca4863;hpb=1705066eceaaea976f010f669ce8e972f3734b05 diff --git a/octave_packages/statistics-1.1.3/harmmean.m b/octave_packages/statistics-1.1.3/harmmean.m new file mode 100644 index 0000000..fcbd45b --- /dev/null +++ b/octave_packages/statistics-1.1.3/harmmean.m @@ -0,0 +1,34 @@ +## Copyright (C) 2001 Paul Kienzle +## +## 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 . + +## -*- 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