summaryrefslogtreecommitdiff
path: root/modules/statistics/macros/iqr.sci
blob: 5d927c1ae3bc23026c497db843b0c61085fe75f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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