annotate scripts/statistics/base/median.m @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children 83a8781b529d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1996, 1997, 1998, 1999, 2000, 2004, 2005, 2006, 2007
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## John W. Eaton
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
3 ##
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
4 ## This file is part of Octave.
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
5 ##
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
7 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6754
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6754
diff changeset
9 ## your option) any later version.
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
10 ##
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
14 ## General Public License for more details.
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
15 ##
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
16 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6754
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6754
diff changeset
18 ## <http://www.gnu.org/licenses/>.
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
19
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
20 ## -*- texinfo -*-
6754
451b346d8c2f [project @ 2007-06-25 17:31:46 by jwe]
jwe
parents: 6046
diff changeset
21 ## @deftypefn {Function File} {} median (@var{x}, @var{dim})
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
22 ## If @var{x} is a vector, compute the median value of the elements of
6754
451b346d8c2f [project @ 2007-06-25 17:31:46 by jwe]
jwe
parents: 6046
diff changeset
23 ## @var{x}. If the elements of @var{x} are sorted, the median is defined
451b346d8c2f [project @ 2007-06-25 17:31:46 by jwe]
jwe
parents: 6046
diff changeset
24 ## as
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
25 ## @iftex
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
26 ## @tex
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
27 ## $$
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
28 ## {\rm median} (x) =
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
29 ## \cases{x(\lceil N/2\rceil), & $N$ odd;\cr
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
30 ## (x(N/2)+x(N/2+1))/2, & $N$ even.}
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
31 ## $$
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
32 ## @end tex
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
33 ## @end iftex
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
34 ## @ifinfo
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
35 ##
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
36 ## @example
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
37 ## @group
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
38 ## x(ceil(N/2)), N odd
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
39 ## median(x) =
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
40 ## (x(N/2) + x((N/2)+1))/2, N even
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
41 ## @end group
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
42 ## @end example
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
43 ## @end ifinfo
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
44 ## If @var{x} is a matrix, compute the median value for each
6754
451b346d8c2f [project @ 2007-06-25 17:31:46 by jwe]
jwe
parents: 6046
diff changeset
45 ## column and return them in a row vector. If the optional @var{dim}
451b346d8c2f [project @ 2007-06-25 17:31:46 by jwe]
jwe
parents: 6046
diff changeset
46 ## argument is given, operate along this dimension.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
47 ## @seealso{std, mean}
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
48 ## @end deftypefn
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
49
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
50 ## Author: jwe
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
51
4852
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
52 function retval = median (a, dim)
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
53
4852
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
54 if (nargin != 1 && nargin != 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 6024
diff changeset
55 print_usage ();
4852
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
56 endif
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
57 if (nargin < 2)
6024
500d884ae373 [project @ 2006-10-03 14:27:33 by jwe]
jwe
parents: 5642
diff changeset
58 dim = find (size (a) > 1, 1);
4852
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
59 if (isempty (dim))
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
60 dim = 1;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
61 endif
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
62 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
63
4852
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
64 sz = size (a);
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
65 s = sort (a, dim);
5123
500f3031866d [project @ 2005-01-27 16:30:09 by jwe]
jwe
parents: 5053
diff changeset
66 if (numel (a) > 0)
4852
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
67 if (numel (a) == sz(dim))
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
68 if (rem (sz(dim), 2) == 0)
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
69 i = sz(dim) / 2;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
70 retval = (s(i) + s(i+1)) / 2;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
71 else
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
72 i = ceil (sz(dim) /2);
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
73 retval = s(i);
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
74 endif
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
75 else
4852
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
76 idx = cell ();
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
77 nd = length (sz);
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
78 for i = 1:nd
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
79 idx{i} = 1:sz(i);
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
80 endfor
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
81 if (rem (sz(dim), 2) == 0)
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
82 i = sz(dim) / 2;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
83 idx{dim} = i;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
84 retval = s(idx{:});
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
85 idx{dim} = i+1;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
86 retval = (retval + s(idx{:})) / 2;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
87 else
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
88 idx{dim} = ceil (sz(dim) / 2);
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
89 retval = s(idx{:});
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
90 endif
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
91 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
92 else
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
93 error ("median: invalid matrix argument");
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
94 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
95
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
96 endfunction