Mercurial > octave-nkf

annotate scripts/statistics/base/prctile.m @ 18204:b29beed0e98d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Use first non-singleton dimension for prctile, quantile (bug #40736). * prctile.m, quantile.m: Use first non-singleton dimension when DIM is unspecified. Change documentation to match new behavior. Add %!tests to validate change.
author Rik <rik@octave.org>
date Fri, 03 Jan 2014 11:58:21 -0800
parents d63878346099
children 4197fc428c7d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 14739
diff changeset
1 ## Copyright (C) 2008-2013 Ben Abbott
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
2 ##
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
3 ## This file is part of Octave.
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
4 ##
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
8 ## your option) any later version.
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
9 ##
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
13 ## General Public License for more details.
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
14 ##
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
18
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
19 ## -*- texinfo -*-
12569
6ef23b4a3402 Add quantile, prctile functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
20 ## @deftypefn {Function File} {@var{q} =} prctile (@var{x})
6ef23b4a3402 Add quantile, prctile functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
21 ## @deftypefnx {Function File} {@var{q} =} prctile (@var{x}, @var{p})
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
22 ## @deftypefnx {Function File} {@var{q} =} prctile (@var{x}, @var{p}, @var{dim})
12569
6ef23b4a3402 Add quantile, prctile functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
23 ## For a sample @var{x}, compute the quantiles, @var{q}, corresponding
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
24 ## to the cumulative probability values, @var{p}, in percent. All non-numeric
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
25 ## values (NaNs) of @var{x} are ignored.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
26 ##
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7643
diff changeset
27 ## If @var{x} is a matrix, compute the percentiles for each column and
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
28 ## return them in a matrix, such that the i-th row of @var{y} contains the
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
29 ## @var{p}(i)th percentiles of each column of @var{x}.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
30 ##
12569
6ef23b4a3402 Add quantile, prctile functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
31 ## If @var{p} is unspecified, return the quantiles for @code{[0 25 50 75 100]}.
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
32 ## The optional argument @var{dim} determines the dimension along which
18204
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
33 ## the percentiles are calculated. If @var{dim} is omitted it defaults to the
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
34 ## the first non-singleton dimension.
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
35 ## @seealso{quantile}
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
36 ## @end deftypefn
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
37
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
38 ## Author: Ben Abbott <bpabbott@mac.com>
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
39 ## Description: Matlab style prctile function.
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
40
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
41 function q = prctile (x, p = [], dim)
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
42
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
43 if (nargin < 1 || nargin > 3)
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
44 print_usage ();
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
45 endif
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
46
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
47 if (! (isnumeric (x) || islogical (x)))
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
48 error ("prctile: X must be a numeric vector or matrix");
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
49 endif
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
50
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
51 if (isempty (p))
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
52 p = [0, 25, 50, 75, 100];
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
53 endif
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
54
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
55 if (! (isnumeric (p) && isvector (p)))
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
56 error ("prctile: P must be a numeric vector");
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
57 endif
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
58
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
59 nd = ndims (x);
18204
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
60 sz = size (x);
14738
c50cc3c50890 prctile.m: Fix error when called with just a single argument (bug #36597).
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
61 if (nargin < 3)
18204
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
62 ## Find the first non-singleton dimension.
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
63 (dim = find (sz > 1, 1)) || (dim = 1);
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
64 else
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
65 if (!(isscalar (dim) && dim == fix (dim))
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
66 || !(1 <= dim && dim <= nd))
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
67 error ("prctile: DIM must be an integer and a valid dimension");
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
68 endif
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
69 endif
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
70
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
71 ## Convert from percent to decimal.
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
72 p /= 100;
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
73
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
74 q = quantile (x, p, dim);
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
75
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
76 endfunction
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
77
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
78
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
79 %!test
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
80 %! pct = 50;
18204
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
81 %! q = prctile (1:4, pct);
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
82 %! qa = 2.5;
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
83 %! assert (q, qa);
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
84 %! q = prctile (1:4, pct, 1);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
85 %! qa = [1, 2, 3, 4];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
86 %! assert (q, qa);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
87 %! q = prctile (1:4, pct, 2);
18204
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
88 %! qa = 2.5;
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
89 %! assert (q, qa);
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
90
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
91 %!test
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
92 %! pct = [50 75];
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
93 %! q = prctile (1:4, pct);
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
94 %! qa = [2.5 3.5];
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
95 %! assert (q, qa);
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
96 %! q = prctile (1:4, pct, 1);
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
97 %! qa = [1, 2, 3, 4; 1, 2, 3, 4];
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
98 %! assert (q, qa);
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
99 %! q = prctile (1:4, pct, 2);
b29beed0e98d Use first non-singleton dimension for prctile, quantile (bug #40736).
Rik <rik@octave.org>
parents: 17744
diff changeset
100 %! qa = [2.5 3.5];
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
101 %! assert (q, qa);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
102
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
103 %!test
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
104 %! pct = 50;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
105 %! x = [0.1126, 0.1148, 0.0521, 0.2364, 0.1393
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
106 %! 0.1718, 0.7273, 0.2041, 0.4531, 0.1585
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
107 %! 0.2795, 0.7978, 0.3296, 0.5567, 0.7307
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
108 %! 0.4288, 0.8753, 0.6477, 0.6287, 0.8165
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
109 %! 0.9331, 0.9312, 0.9635, 0.7796, 0.8461];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
110 %! tol = 0.0001;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
111 %! q = prctile (x, pct, 1);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
112 %! qa = [0.2795, 0.7978, 0.3296, 0.5567, 0.7307];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
113 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
114 %! q = prctile (x, pct, 2);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
115 %! qa = [0.1148; 0.2041; 0.5567; 0.6477; 0.9312];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
116 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
117
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
118 %!test
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
119 %! pct = 50;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
120 %! tol = 0.0001;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
121 %! x = [0.1126, 0.1148, 0.0521, 0.2364, 0.1393
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
122 %! 0.1718, 0.7273, 0.2041, 0.4531, 0.1585
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
123 %! 0.2795, 0.7978, 0.3296, 0.5567, 0.7307
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
124 %! 0.4288, 0.8753, 0.6477, 0.6287, 0.8165
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
125 %! 0.9331, 0.9312, 0.9635, 0.7796, 0.8461];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
126 %! x(5,5) = Inf;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
127 %! q = prctile (x, pct, 1);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
128 %! qa = [0.2795, 0.7978, 0.3296, 0.5567, 0.7307];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
129 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
130 %! x(5,5) = -Inf;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
131 %! q = prctile (x, pct, 1);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
132 %! qa = [0.2795, 0.7978, 0.3296, 0.5567, 0.1585];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
133 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
134 %! x(1,1) = Inf;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
135 %! q = prctile (x, pct, 1);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
136 %! qa = [0.4288, 0.7978, 0.3296, 0.5567, 0.1585];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
137 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
138
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
139 %!test
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
140 %! pct = 50;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
141 %! tol = 0.0001;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
142 %! x = [0.1126, 0.1148, 0.0521, 0.2364, 0.1393
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
143 %! 0.1718, 0.7273, 0.2041, 0.4531, 0.1585
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
144 %! 0.2795, 0.7978, 0.3296, 0.5567, 0.7307
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
145 %! 0.4288, 0.8753, 0.6477, 0.6287, 0.8165
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
146 %! 0.9331, 0.9312, 0.9635, 0.7796, 0.8461];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
147 %! x(3,3) = Inf;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
148 %! q = prctile (x, pct, 1);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
149 %! qa = [0.2795, 0.7978, 0.6477, 0.5567, 0.7307];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
150 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
151 %! q = prctile (x, pct, 2);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
152 %! qa = [0.1148; 0.2041; 0.7307; 0.6477; 0.9312];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
153 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
154
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
155 %!test
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
156 %! pct = 50;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
157 %! tol = 0.0001;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
158 %! x = [0.1126, 0.1148, 0.0521, 0.2364, 0.1393
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
159 %! 0.1718, 0.7273, 0.2041, 0.4531, 0.1585
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
160 %! 0.2795, 0.7978, 0.3296, 0.5567, 0.7307
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
161 %! 0.4288, 0.8753, 0.6477, 0.6287, 0.8165
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
162 %! 0.9331, 0.9312, 0.9635, 0.7796, 0.8461];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
163 %! x(5,5) = NaN;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
164 %! q = prctile (x, pct, 2);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
165 %! qa = [0.1148; 0.2041; 0.5567; 0.6477; 0.9322];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
166 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
167 %! x(1,1) = NaN;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
168 %! q = prctile (x, pct, 2);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
169 %! qa = [0.1270; 0.2041; 0.5567; 0.6477; 0.9322];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
170 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
171 %! x(3,3) = NaN;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
172 %! q = prctile (x, pct, 2);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
173 %! qa = [0.1270; 0.2041; 0.6437; 0.6477; 0.9322];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
174 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
175
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
176 %% Test input validation
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
177 %!error prctile ()
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
178 %!error prctile (1, 2, 3, 4)
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
179 %!error prctile (['A'; 'B'], 10)
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
180 %!error prctile (1:10, [true, false])
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
181 %!error prctile (1:10, ones (2,2))
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
182 %!error prctile (1, 1, 1.5)
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
183 %!error prctile (1, 1, 0)
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
184 %!error prctile (1, 1, 3)
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
185