summaryrefslogtreecommitdiff
path: root/modules/statistics/macros/iqr.sci
diff options
context:
space:
mode:
Diffstat (limited to 'modules/statistics/macros/iqr.sci')
-rwxr-xr-xmodules/statistics/macros/iqr.sci62
1 files changed, 62 insertions, 0 deletions
diff --git a/modules/statistics/macros/iqr.sci b/modules/statistics/macros/iqr.sci
new file mode 100755
index 000000000..5d927c1ae
--- /dev/null
+++ b/modules/statistics/macros/iqr.sci
@@ -0,0 +1,62 @@
+
+// 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 [q]=iqr(x,orien)
+ //
+ //This function computes the interquartile range IQR= upper quartile -
+ //lower quartile of a vector or a matrix x.
+ //
+ //For a vector or a matrix x, q=iqr(x) returns in the scalar q the
+ //interquartile range of all the entries of x.
+ //
+ //q=iqr(x,'r') (or, equivalently, q=iqr(x,1)) is the rowwise
+ //interquartile range. It returns in each entry of the row vector q the
+ //interquartile range of each column of x.
+ //
+ //q-iqr(x,'c') (or, equivalently, q=iqr(x,2)) is the columnwise
+ //interquartile range. It returns in each entry of the column vector q
+ //the interquartile range of each row 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 argument: At least %d expected.\n"),"iqr",1));
+ end
+
+ if rhs == 1 then
+ if x == [] | and(isnan(x)) then
+ q = %nan;
+ return
+ end
+
+ qq = quart(x)
+ q = qq(3) - qq(1);
+ else
+ qq=quart(x,orien);
+ if orien == "r" | orien == 1 then
+ if size(x,1) == 1 then
+ error(msprintf(_("%s: Wrong dimensions for input argument #%d: A column vector or matrix expected.\n"), "iqr", 1));
+ end
+ q = qq(3, :) - qq(1, :);
+ elseif orien == "c" | orien == 2 then
+ if size(x,2) == 1 then
+ error(msprintf(_("%s: Wrong dimensions for input argument #%d: A row vector or matrix expected.\n"), "iqr", 1));
+ end
+ q = qq(:,3) - qq(:, 1);
+ else
+ error(msprintf(_("%s: Wrong value for input argument #%d: ''%s'', %d, ''%s'' or %d expected.\n"), "iqr", 2, "r", 1, "c", 2));
+ end
+ end
+endfunction