annotate scripts/statistics/base/median.m @ 5307:4c8a2e4e0717

[project @ 2005-04-26 19:24:27 by jwe]
author jwe
date Tue, 26 Apr 2005 19:24:47 +0000
parents 500f3031866d
children 2618a0750ae6
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) 1996, 1997 John W. Eaton
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
2 ##
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
4 ##
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
5 ## 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
6 ## under the terms of the GNU General Public License as published by
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.
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
9 ##
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
10 ## 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
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
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
14 ##
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
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
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: 5123
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: 5123
diff changeset
18 ## 02110-1301, USA.
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 -*-
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
21 ## @deftypefn {Function File} {} median (@var{x})
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
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
23 ## @var{x}.
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
24 ## @iftex
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
25 ## @tex
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
26 ## $$
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
27 ## {\rm median} (x) =
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
28 ## \cases{x(\lceil N/2\rceil), & $N$ odd;\cr
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
29 ## (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
30 ## $$
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
31 ## @end tex
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
32 ## @end iftex
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
33 ## @ifinfo
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
34 ##
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
35 ## @example
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
36 ## @group
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
37 ## x(ceil(N/2)), N odd
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
38 ## median(x) =
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
39 ## (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
40 ## @end group
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
41 ## @end example
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
42 ## @end ifinfo
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
43 ## If @var{x} is a matrix, compute the median value for each
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
44 ## column and return them in a row vector.
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3200
diff changeset
45 ## @end deftypefn
5053
c08cb1098afc [project @ 2004-10-19 23:10:54 by jwe]
jwe
parents: 4852
diff changeset
46 ##
3408
ae7adbb591e8 [project @ 2000-01-06 08:29:11 by jwe]
jwe
parents: 3407
diff changeset
47 ## @seealso{std and mean}
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
48
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
49 ## Author: jwe
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
50
4852
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
51 function retval = median (a, dim)
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
52
4852
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
53 if (nargin != 1 && nargin != 2)
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
54 usage ("median (a, dim)");
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
55 endif
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
56 if (nargin < 2)
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
57 dim = min (find (size (a) > 1));
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
58 if (isempty (dim))
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
59 dim = 1;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
60 endif
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
61 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
62
4852
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
63 sz = size (a);
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
64 s = sort (a, dim);
5123
500f3031866d [project @ 2005-01-27 16:30:09 by jwe]
jwe
parents: 5053
diff changeset
65 if (numel (a) > 0)
4852
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
66 if (numel (a) == sz(dim))
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
67 if (rem (sz(dim), 2) == 0)
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
68 i = sz(dim) / 2;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
69 retval = (s(i) + s(i+1)) / 2;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
70 else
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
71 i = ceil (sz(dim) /2);
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
72 retval = s(i);
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
73 endif
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
74 else
4852
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
75 idx = cell ();
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
76 nd = length (sz);
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
77 for i = 1:nd
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
78 idx{i} = 1:sz(i);
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
79 endfor
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
80 if (rem (sz(dim), 2) == 0)
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
81 i = sz(dim) / 2;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
82 idx{dim} = i;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
83 retval = s(idx{:});
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
84 idx{dim} = i+1;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
85 retval = (retval + s(idx{:})) / 2;
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
86 else
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
87 idx{dim} = ceil (sz(dim) / 2);
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
88 retval = s(idx{:});
404c7122853e [project @ 2004-04-06 17:23:37 by jwe]
jwe
parents: 3426
diff changeset
89 endif
3200
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
90 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
91 else
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
92 error ("median: invalid matrix argument");
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
93 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
94
781c930425fd [project @ 1998-10-29 05:23:08 by jwe]
jwe
parents:
diff changeset
95 endfunction