annotate scripts/statistics/base/prctile.m @ 14363:f3d52523cde1

Use Octave coding conventions in all m-file %!test blocks * wavread.m, acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m, asec.m, asecd.m, asech.m, asind.m, atand.m, cosd.m, cot.m, cotd.m, coth.m, csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m, accumarray.m, accumdim.m, bitcmp.m, bitget.m, bitset.m, blkdiag.m, cart2pol.m, cart2sph.m, celldisp.m, chop.m, circshift.m, colon.m, common_size.m, cplxpair.m, cumtrapz.m, curl.m, dblquad.m, deal.m, divergence.m, flipdim.m, fliplr.m, flipud.m, genvarname.m, gradient.m, idivide.m, int2str.m, interp1.m, interp1q.m, interp2.m, interp3.m, interpft.m, interpn.m, isa.m, isdir.m, isequal.m, isequalwithequalnans.m, issquare.m, logspace.m, nargchk.m, narginchk.m, nargoutchk.m, nextpow2.m, nthargout.m, num2str.m, pol2cart.m, polyarea.m, postpad.m, prepad.m, profile.m, profshow.m, quadgk.m, quadv.m, randi.m, rat.m, repmat.m, rot90.m, rotdim.m, shift.m, shiftdim.m, sph2cart.m, structfun.m, trapz.m, triplequad.m, convhull.m, dsearch.m, dsearchn.m, griddata3.m, griddatan.m, rectint.m, tsearchn.m, __makeinfo__.m, doc.m, get_first_help_sentence.m, help.m, type.m, unimplemented.m, which.m, imread.m, imwrite.m, dlmwrite.m, fileread.m, is_valid_file_id.m, strread.m, textread.m, textscan.m, commutation_matrix.m, cond.m, condest.m, cross.m, duplication_matrix.m, expm.m, housh.m, isdefinite.m, ishermitian.m, issymmetric.m, logm.m, normest.m, null.m, onenormest.m, orth.m, planerot.m, qzhess.m, rank.m, rref.m, trace.m, vech.m, ans.m, bincoeff.m, bug_report.m, bzip2.m, comma.m, compare_versions.m, computer.m, edit.m, fileparts.m, fullfile.m, getfield.m, gzip.m, info.m, inputname.m, isappdata.m, isdeployed.m, ismac.m, ispc.m, isunix.m, list_primes.m, ls.m, mexext.m, namelengthmax.m, news.m, orderfields.m, paren.m, recycle.m, rmappdata.m, semicolon.m, setappdata.m, setfield.m, substruct.m, symvar.m, ver.m, version.m, warning_ids.m, xor.m, fminbnd.m, fsolve.m, fzero.m, lsqnonneg.m, optimset.m, pqpnonneg.m, sqp.m, matlabroot.m, __gnuplot_drawnow__.m, __plt_get_axis_arg__.m, ancestor.m, cla.m, clf.m, close.m, colorbar.m, colstyle.m, comet3.m, contourc.m, figure.m, gca.m, gcbf.m, gcbo.m, gcf.m, ginput.m, graphics_toolkit.m, gtext.m, hggroup.m, hist.m, hold.m, isfigure.m, ishghandle.m, ishold.m, isocolors.m, isonormals.m, isosurface.m, isprop.m, legend.m, line.m, loglog.m, loglogerr.m, meshgrid.m, ndgrid.m, newplot.m, orient.m, patch.m, plot3.m, plotyy.m, __print_parse_opts__.m, quiver3.m, refreshdata.m, ribbon.m, semilogx.m, semilogxerr.m, semilogy.m, stem.m, stem3.m, subplot.m, title.m, uigetfile.m, view.m, whitebg.m, compan.m, conv.m, deconv.m, mkpp.m, mpoles.m, pchip.m, poly.m, polyaffine.m, polyder.m, polyfit.m, polygcd.m, polyint.m, polyout.m, polyval.m, polyvalm.m, ppder.m, ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, intersect.m, ismember.m, powerset.m, setdiff.m, setxor.m, union.m, unique.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m, fftconv.m, fftfilt.m, fftshift.m, freqz.m, hamming.m, hanning.m, ifftshift.m, sinc.m, sinetone.m, sinewave.m, unwrap.m, bicg.m, bicgstab.m, gmres.m, gplot.m, nonzeros.m, pcg.m, pcr.m, spaugment.m, spconvert.m, spdiags.m, speye.m, spfun.m, spones.m, sprand.m, sprandsym.m, spstats.m, spy.m, svds.m, treelayout.m, bessel.m, beta.m, betaln.m, factor.m, factorial.m, isprime.m, lcm.m, legendre.m, nchoosek.m, nthroot.m, perms.m, pow2.m, primes.m, reallog.m, realpow.m, realsqrt.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, rosser.m, vander.m, __finish__.m, center.m, cloglog.m, corr.m, cov.m, gls.m, histc.m, iqr.m, kendall.m, kurtosis.m, logit.m, mahalanobis.m, mean.m, meansq.m, median.m, mode.m, moment.m, ols.m, ppplot.m, prctile.m, probit.m, quantile.m, range.m, ranks.m, run_count.m, runlength.m, skewness.m, spearman.m, statistics.m, std.m, table.m, var.m, zscore.m, betacdf.m, betainv.m, betapdf.m, betarnd.m, binocdf.m, binoinv.m, binopdf.m, binornd.m, cauchy_cdf.m, cauchy_inv.m, cauchy_pdf.m, cauchy_rnd.m, chi2cdf.m, chi2inv.m, chi2pdf.m, chi2rnd.m, discrete_cdf.m, discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m, empirical_inv.m, empirical_pdf.m, empirical_rnd.m, expcdf.m, expinv.m, exppdf.m, exprnd.m, fcdf.m, finv.m, fpdf.m, frnd.m, gamcdf.m, gaminv.m, gampdf.m, gamrnd.m, geocdf.m, geoinv.m, geopdf.m, geornd.m, hygecdf.m, hygeinv.m, hygepdf.m, hygernd.m, kolmogorov_smirnov_cdf.m, laplace_cdf.m, laplace_inv.m, laplace_pdf.m, laplace_rnd.m, logistic_cdf.m, logistic_inv.m, logistic_pdf.m, logistic_rnd.m, logncdf.m, logninv.m, lognpdf.m, lognrnd.m, nbincdf.m, nbininv.m, nbinpdf.m, nbinrnd.m, normcdf.m, norminv.m, normpdf.m, normrnd.m, poisscdf.m, poissinv.m, poisspdf.m, poissrnd.m, stdnormal_cdf.m, stdnormal_inv.m, stdnormal_pdf.m, stdnormal_rnd.m, tcdf.m, tinv.m, tpdf.m, trnd.m, unidcdf.m, unidinv.m, unidpdf.m, unidrnd.m, unifcdf.m, unifinv.m, unifpdf.m, unifrnd.m, wblcdf.m, wblinv.m, wblpdf.m, wblrnd.m, kolmogorov_smirnov_test.m, kruskal_wallis_test.m, base2dec.m, bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m, findstr.m, hex2dec.m, index.m, isletter.m, mat2str.m, rindex.m, str2num.m, strcat.m, strjust.m, strmatch.m, strsplit.m, strtok.m, strtrim.m, strtrunc.m, substr.m, validatestring.m, demo.m, example.m, fail.m, speed.m, addtodate.m, asctime.m, clock.m, ctime.m, date.m, datenum.m, datetick.m, datevec.m, eomday.m, etime.m, is_leap_year.m, now.m: Use Octave coding conventions in all m-file %!test blocks
author Rik <octave@nomad.inbox5.com>
date Mon, 13 Feb 2012 07:29:44 -0800
parents 72c96de7a403
children 31e2c4248664
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 12656
diff changeset
1 ## Copyright (C) 2008-2012 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
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7643
diff changeset
33 ## the percentiles are calculated. If @var{dim} is omitted, and @var{x} is
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
34 ## a vector or matrix, it defaults to 1 (column-wise quantiles). When
12642
f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 12569
diff changeset
35 ## @var{x} is an N-D array, @var{dim} defaults to the first non-singleton
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
36 ## dimension.
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
37 ## @seealso{quantile}
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
38 ## @end deftypefn
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
39
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
40 ## Author: Ben Abbott <bpabbott@mac.com>
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
41 ## Description: Matlab style prctile function.
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
42
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
43 function q = prctile (x, p = [], dim)
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
44
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
45 if (nargin < 1 || nargin > 3)
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
46 print_usage ();
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
47 endif
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
48
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
49 if (! (isnumeric (x) || islogical (x)))
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
50 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
51 endif
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
52
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
53 if (isempty (p))
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
54 p = [0, 25, 50, 75, 100];
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
55 endif
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
56
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
57 if (! (isnumeric (p) && isvector (p)))
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
58 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
59 endif
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
60
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
61 nd = ndims (x);
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
62 if (nargin == 2)
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
63 if (nd == 2)
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
64 ## If a matrix or vector, always use 1st dimension.
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
65 dim = 1;
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
66 else
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
67 ## If an N-d array, find the first non-singleton dimension.
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
68 (dim = find (sz > 1, 1)) || (dim = 1);
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
69 endif
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
70 else
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
71 if (!(isscalar (dim) && dim == fix (dim))
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
72 || !(1 <= dim && dim <= nd))
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
73 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
74 endif
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
75 endif
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
76
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
77 ## Convert from percent to decimal.
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
78 p /= 100;
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
79
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
80 q = quantile (x, p, dim);
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
81
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
82 endfunction
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
83
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
84
7643
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
85 %!test
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
86 %! pct = 50;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
87 %! q = prctile (1:4, pct, 1);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
88 %! qa = [1, 2, 3, 4];
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
89 %! assert (q, qa);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
90 %! q = prctile (1:4, pct, 2);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
91 %! qa = 2.5000;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
92 %! assert (q, qa);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
93
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
94 %!test
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
95 %! pct = 50;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
96 %! 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
97 %! 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
98 %! 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
99 %! 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
100 %! 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
101 %! tol = 0.0001;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
102 %! q = prctile (x, pct, 1);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
103 %! 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
104 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
105 %! q = prctile (x, pct, 2);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
106 %! 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
107 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
108
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
109 %!test
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
110 %! pct = 50;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
111 %! tol = 0.0001;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
112 %! 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
113 %! 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
114 %! 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
115 %! 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
116 %! 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
117 %! x(5,5) = Inf;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
118 %! q = prctile (x, pct, 1);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
119 %! 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
120 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
121 %! x(5,5) = -Inf;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
122 %! q = prctile (x, pct, 1);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
123 %! 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
124 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
125 %! x(1,1) = Inf;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
126 %! q = prctile (x, pct, 1);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
127 %! 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
128 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
129
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
130 %!test
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
131 %! pct = 50;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
132 %! tol = 0.0001;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
133 %! 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
134 %! 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
135 %! 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
136 %! 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
137 %! 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
138 %! x(3,3) = Inf;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
139 %! q = prctile (x, pct, 1);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
140 %! 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
141 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
142 %! q = prctile (x, pct, 2);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
143 %! 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
144 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
145
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
146 %!test
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
147 %! pct = 50;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
148 %! tol = 0.0001;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
149 %! 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
150 %! 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
151 %! 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
152 %! 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
153 %! 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
154 %! x(5,5) = NaN;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
155 %! q = prctile (x, pct, 2);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
156 %! 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
157 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
158 %! x(1,1) = NaN;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
159 %! q = prctile (x, pct, 2);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
160 %! 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
161 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
162 %! x(3,3) = NaN;
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
163 %! q = prctile (x, pct, 2);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
164 %! 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
165 %! assert (q, qa, tol);
0220da981c2a Modified statistics to calculate consistent median.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
166
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
167 %% Test input validation
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
168 %!error prctile ()
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
169 %!error prctile (1, 2, 3, 4)
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
170 %!error prctile (['A'; 'B'], 10)
11436
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
171 %!error prctile (1:10, [true, false])
12656
6b2f14af2360 Overhaul functions in statistics/base directory.
Rik <octave@nomad.inbox5.com>
parents: 12642
diff changeset
172 %!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
173 %!error prctile (1, 1, 1.5)
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
174 %!error prctile (1, 1, 0)
e151e23f73bc Overhaul base statistics functions and documentation of same.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
175 %!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
176