diff options
Diffstat (limited to 'modules/statistics/macros/harmean.sci')
| -rwxr-xr-x | modules/statistics/macros/harmean.sci | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/modules/statistics/macros/harmean.sci b/modules/statistics/macros/harmean.sci new file mode 100755 index 000000000..4261019d7 --- /dev/null +++ b/modules/statistics/macros/harmean.sci @@ -0,0 +1,53 @@ + +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 1999 - INRIA - Carlos Klimann +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt +// + +function [hm]=harmean(x,orien) + //This function computes the harmonic mean of a vector or matrix x. + // + //For a vector or matrix x, hm=harmean(x) returns in scalar hm the + //harmonic mean of all the entries of x. + // + //hm=harmean(x,'r')(or, equivalently, hm=harmean(x,1)) returns in each + //entry of the row vector hm the harmonic mean of each column of x. + // + //hm=harmean(x,'c')(or, equivalently, hm=harmean(x,2)) returns in each + //entry of the column vector hm the harmonic mean of each row of x. + // + //Nota: In the computation of the harmonic mean we consider only the non + //zero values of x. + // + //References: Wonacott, T.H. & Wonacott, R.J.; Introductory + //Statistics, J.Wiley & Sons, 1990. + // + // + [lhs, rhs] = argn(0) + if rhs == 0 then + error(msprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"),"harmean",1,2)) + end + if x == [] then + hm = %nan + return + end + if rhs == 1 then + hm = 1/(sum(1 ./x(x<>0))/sum(x<>0)) + return + elseif rhs == 2 then + if orien == "r" | orien == 1 then + le = ones(1,size(x,1))*bool2s(x<>0) + elseif orien == "c" | orien == 2 then + le = bool2s(x<>0)*ones(size(x,2),1) + else error(msprintf(gettext("%s: Wrong value for input argument #%d: ''%s'', ''%s'', %d or %d expected.\n"),"harmean",2,"r","c",1,2)), end + x(x==0) = %inf + hm = 1 ./(sum(1 ./x,orien) ./le) + else + error(msprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"),"harmean",1,2)), + end +endfunction |