annotate scripts/statistics/base/iqr.m @ 5435:66ad03c58880

[project @ 2005-08-31 20:41:47 by jwe]
author jwe
date Wed, 31 Aug 2005 20:41:48 +0000
parents 2a16423e4aa0
children 34f96dd5441b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1995, 1996, 1997 Kurt Hornik
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3200
diff changeset
2 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
3 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
4 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
6 ## under the terms of the GNU General Public License as published by
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3200
diff changeset
9 ##
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3200
diff changeset
13 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3200
diff changeset
14 ##
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
3922
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe]
jwe
parents: 3456
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4886
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4886
diff changeset
18 ## 02110-1301, USA.
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
19
3453
71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe]
jwe
parents: 3426
diff changeset
20 ## -*- texinfo -*-
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
21 ## @deftypefn {Function File} {} iqr (@var{x}, @var{dim})
3453
71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe]
jwe
parents: 3426
diff changeset
22 ## If @var{x} is a vector, return the interquartile range, i.e., the
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
23 ## difference between the upper and lower quartile, of the input data.
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
24 ##
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
25 ## If @var{x} is a matrix, do the above for first non singleton
5435
66ad03c58880 [project @ 2005-08-31 20:41:47 by jwe]
jwe
parents: 5428
diff changeset
26 ## dimension of @var{x}. If the option @var{dim} argument is given,
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
27 ## then operate along this dimension.
3453
71d2e09c15a2 [project @ 2000-01-18 08:32:09 by jwe]
jwe
parents: 3426
diff changeset
28 ## @end deftypefn
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3200
diff changeset
29
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
30 ## Author KH <Kurt.Hornik@wu-wien.ac.at>
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3453
diff changeset
31 ## Description: Interquartile range
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
32
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
33 function y = iqr (x, dim)
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3200
diff changeset
34
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
35 if (nargin != 1 && nargin != 2)
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
36 usage ("iqr (x, dim)");
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
37 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
38
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
39 nd = ndims (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
40 sz = size (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
41 nel = numel (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
42 if (nargin != 2)
4886
54b076a24718 [project @ 2004-04-30 04:31:51 by jwe]
jwe
parents: 4885
diff changeset
43 ## Find the first non-singleton dimension.
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
44 dim = 1;
4886
54b076a24718 [project @ 2004-04-30 04:31:51 by jwe]
jwe
parents: 4885
diff changeset
45 while (dim < nd + 1 && sz(dim) == 1)
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
46 dim = dim + 1;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
47 endwhile
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
48 if (dim > nd)
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
49 dim = 1;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
50 endif
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
51 else
4886
54b076a24718 [project @ 2004-04-30 04:31:51 by jwe]
jwe
parents: 4885
diff changeset
52 if (! (isscalar (dim) && dim == round (dim))
54b076a24718 [project @ 2004-04-30 04:31:51 by jwe]
jwe
parents: 4885
diff changeset
53 && dim > 0
54b076a24718 [project @ 2004-04-30 04:31:51 by jwe]
jwe
parents: 4885
diff changeset
54 && dim < (nd + 1))
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
55 error ("iqr: dim must be an integer and valid dimension");
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
56 endif
4681
bb9515a3527d [project @ 2003-12-18 15:35:09 by jwe]
jwe
parents: 4631
diff changeset
57 endif
4631
cae0b7c46842 [project @ 2003-11-18 18:30:06 by jwe]
jwe
parents: 3922
diff changeset
58
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
59 ## This code is a bit heavy, but is needed until empirical_inv
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
60 ## takes other than vector arguments.
4886
54b076a24718 [project @ 2004-04-30 04:31:51 by jwe]
jwe
parents: 4885
diff changeset
61 c = sz(dim);
54b076a24718 [project @ 2004-04-30 04:31:51 by jwe]
jwe
parents: 4885
diff changeset
62 sz(dim) = 1;
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
63 y = zeros (sz);
4886
54b076a24718 [project @ 2004-04-30 04:31:51 by jwe]
jwe
parents: 4885
diff changeset
64 stride = prod (sz(1:dim-1));
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
65 for i = 1 : nel / c;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
66 offset = i;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
67 offset2 = 0;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
68 while (offset > stride)
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
69 offset -= stride;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
70 offset2++;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
71 endwhile
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
72 offset += offset2 * stride * c;
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
73 rng = [0 : c-1] * stride + offset;
4631
cae0b7c46842 [project @ 2003-11-18 18:30:06 by jwe]
jwe
parents: 3922
diff changeset
74
4885
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe]
jwe
parents: 4681
diff changeset
75 y (i) = empirical_inv (3/4, x(rng)) - empirical_inv (1/4, x(rng));
4681
bb9515a3527d [project @ 2003-12-18 15:35:09 by jwe]
jwe
parents: 4631
diff changeset
76 endfor
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3200
diff changeset
77
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
78 endfunction