Mercurial > octave-nkf
view scripts/statistics/base/mode.m @ 14868:5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
* lin2mu.m, loadaudio.m, wavread.m, accumarray.m, bicubic.m, celldisp.m,
colon.m, cplxpair.m, dblquad.m, divergence.m, genvarname.m, gradient.m,
int2str.m, interp1.m, interp1q.m, interp2.m, interpn.m, loadobj.m, nthargout.m,
__isequal__.m, __splinen__.m, quadgk.m, quadl.m, quadv.m, rat.m, rot90.m,
rotdim.m, saveobj.m, subsindex.m, triplequad.m, delaunay3.m, griddata.m,
inpolygon.m, tsearchn.m, voronoi.m, get_first_help_sentence.m, which.m,
gray2ind.m, pink.m, dlmwrite.m, strread.m, textread.m, textscan.m, housh.m,
ishermitian.m, issymmetric.m, krylov.m, logm.m, null.m, rref.m,
compare_versions.m, copyfile.m, dump_prefs.m, edit.m, fileparts.m,
getappdata.m, isappdata.m, movefile.m, orderfields.m, parseparams.m,
__xzip__.m, rmappdata.m, setappdata.m, swapbytes.m, unpack.m, ver.m, fminbnd.m,
fminunc.m, fsolve.m, glpk.m, lsqnonneg.m, qp.m, sqp.m, configure_make.m,
copy_files.m, describe.m, get_description.m, get_forge_pkg.m, install.m,
installed_packages.m, is_architecture_dependent.m, load_package_dirs.m,
print_package_description.m, rebuild.m, repackage.m, save_order.m, shell.m,
allchild.m, ancestor.m, area.m, axes.m, axis.m, clabel.m, close.m, colorbar.m,
comet.m, comet3.m, contour.m, cylinder.m, ezmesh.m, ezsurf.m, findobj.m,
fplot.m, hist.m, isocolors.m, isonormals.m, isosurface.m, isprop.m, legend.m,
mesh.m, meshz.m, pareto.m, pcolor.m, peaks.m, plot3.m, plotmatrix.m, plotyy.m,
polar.m, print.m, __add_datasource__.m, __add_default_menu__.m,
__axes_limits__.m, __bar__.m, __clabel__.m, __contour__.m, __errcomm__.m,
__errplot__.m, __ezplot__.m, __file_filter__.m, __fltk_print__.m,
__ghostscript__.m, __gnuplot_print__.m, __go_draw_axes__.m,
__go_draw_figure__.m, __interp_cube__.m, __marching_cube__.m, __patch__.m,
__pie__.m, __plt__.m, __print_parse_opts__.m, __quiver__.m, __scatter__.m,
__stem__.m, __tight_eps_bbox__.m, __uigetdir_fltk__.m, __uigetfile_fltk__.m,
__uiputfile_fltk__.m, quiver.m, quiver3.m, rectangle.m, refreshdata.m,
ribbon.m, scatter.m, semilogy.m, shading.m, slice.m, subplot.m, surface.m,
surfl.m, surfnorm.m, text.m, uigetfile.m, uiputfile.m, whitebg.m, deconv.m,
mkpp.m, pchip.m, polyaffine.m, polyder.m, polygcd.m, polyout.m, polyval.m,
ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, splinefit.m,
addpref.m, getpref.m, setpref.m, ismember.m, setxor.m, arch_fit.m, arch_rnd.m,
arch_test.m, autoreg_matrix.m, diffpara.m, fftconv.m, filter2.m, hanning.m,
hurst.m, periodogram.m, triangle_sw.m, sinc.m, spectral_xdf.m, spencer.m,
stft.m, synthesis.m, unwrap.m, yulewalker.m, bicgstab.m, gmres.m, pcg.m, pcr.m,
__sprand_impl__.m, speye.m, spfun.m, sprandn.m, spstats.m, svds.m,
treelayout.m, treeplot.m, bessel.m, factor.m, legendre.m, perms.m, primes.m,
magic.m, toeplitz.m, corr.m, cov.m, mean.m, median.m, mode.m, qqplot.m,
quantile.m, ranks.m, zscore.m, logistic_regression_likelihood.m,
bartlett_test.m, chisquare_test_homogeneity.m, chisquare_test_independence.m,
kolmogorov_smirnov_test.m, run_test.m, u_test.m, wilcoxon_test.m, z_test.m,
z_test_2.m, bin2dec.m, dec2base.m, mat2str.m, strcat.m, strchr.m, strjust.m,
strtok.m, substr.m, untabify.m, assert.m, demo.m, example.m, fail.m, speed.m,
test.m, now.m: Use Octave coding conventions for cuddling parentheses in
scripts directory.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 17 Jul 2012 07:08:39 -0700 |
parents | f3d52523cde1 |
children | d63878346099 |
line wrap: on
line source
## Copyright (C) 2007-2012 David Bateman ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} mode (@var{x}) ## @deftypefnx {Function File} {} mode (@var{x}, @var{dim}) ## @deftypefnx {Function File} {[@var{m}, @var{f}, @var{c}] =} mode (@dots{}) ## Compute the most frequently occurring value in a dataset (mode). ## @code{mode} determines the frequency of values along the first non-singleton ## dimension and returns the value with the highest frequency. If two, or ## more, values have the same frequency @code{mode} returns the smallest. ## ## If the optional argument @var{dim} is given, operate along this dimension. ## ## The return variable @var{f} is the number of occurrences of the mode in ## in the dataset. The cell array @var{c} contains all of the elements ## with the maximum frequency. ## @seealso{mean, median} ## @end deftypefn function [m, f, c] = mode (x, dim) if (nargin < 1 || nargin > 2) print_usage (); endif if (! (isnumeric (x) || islogical (x))) error ("mode: X must be a numeric vector or matrix"); endif nd = ndims (x); sz = size (x); if (nargin < 2) ## Find the first non-singleton dimension. (dim = find (sz > 1, 1)) || (dim = 1); else if (!(isscalar (dim) && dim == fix (dim)) || !(1 <= dim && dim <= nd)) error ("mode: DIM must be an integer and a valid dimension"); endif endif sz2 = sz; sz2(dim) = 1; sz3 = ones (1, nd); sz3(dim) = sz(dim); if (issparse (x)) t2 = sparse (sz(1), sz(2)); else t2 = zeros (sz); endif if (dim != 1) perm = [dim, 1:dim-1, dim+1:nd]; t2 = permute (t2, perm); endif xs = sort (x, dim); t = cat (dim, true (sz2), diff (xs, 1, dim) != 0); if (dim != 1) t2(permute (t != 0, perm)) = diff ([find(permute (t, perm))(:); prod(sz)+1]); f = max (ipermute (t2, perm), [], dim); xs = permute (xs, perm); else t2(t) = diff ([find(t)(:); prod(sz)+1]); f = max (t2, [], dim); endif c = cell (sz2); if (issparse (x)) m = sparse (sz2(1), sz2(2)); else m = zeros (sz2, class (x)); endif for i = 1 : prod (sz2) c{i} = xs(t2(:, i) == f(i), i); m(i) = c{i}(1); endfor endfunction %!test %! [m, f, c] = mode (toeplitz (1:5)); %! assert (m, [1,2,2,2,1]); %! assert (f, [1,2,2,2,1]); %! assert (c, {[1;2;3;4;5],[2],[2;3],[2],[1;2;3;4;5]}); %!test %! [m, f, c] = mode (toeplitz (1:5), 2); %! assert (m, [1;2;2;2;1]); %! assert (f, [1;2;2;2;1]); %! assert (c, {[1;2;3;4;5];[2];[2;3];[2];[1;2;3;4;5]}); %!test %! a = sprandn (32, 32, 0.05); %! [m, f, c] = mode (a); %! [m2, f2, c2] = mode (full (a)); %! assert (m, sparse (m2)); %! assert (f, sparse (f2)); %! c_exp(1:length (a)) = { sparse (0) }; %! assert (c ,c_exp); %! assert (c2,c_exp ); %!assert (mode ([2,3,1,2,3,4],1),[2,3,1,2,3,4]) %!assert (mode ([2,3,1,2,3,4],2),2) %!assert (mode ([2,3,1,2,3,4]),2) %!assert (mode (single ([2,3,1,2,3,4])), single (2)) %!assert (mode (int8 ([2,3,1,2,3,4])), int8 (2)) %!assert (mode ([2;3;1;2;3;4],1),2) %!assert (mode ([2;3;1;2;3;4],2),[2;3;1;2;3;4]) %!assert (mode ([2;3;1;2;3;4]),2) %!shared x %! x(:,:,1) = toeplitz (1:3); %! x(:,:,2) = circshift (toeplitz (1:3), 1); %! x(:,:,3) = circshift (toeplitz (1:3), 2); %!test %! [m, f, c] = mode (x, 1); %! assert (reshape (m, [3, 3]), [1 1 1; 2 2 2; 1 1 1]); %! assert (reshape (f, [3, 3]), [1 1 1; 2 2 2; 1 1 1]); %! c = reshape (c, [3, 3]); %! assert (c{1}, [1; 2; 3]); %! assert (c{2}, 2); %! assert (c{3}, [1; 2; 3]); %!test %! [m, f, c] = mode (x, 2); %! assert (reshape (m, [3, 3]), [1 1 2; 2 1 1; 1 2 1]); %! assert (reshape (f, [3, 3]), [1 1 2; 2 1 1; 1 2 1]); %! c = reshape (c, [3, 3]); %! assert (c{1}, [1; 2; 3]); %! assert (c{2}, 2); %! assert (c{3}, [1; 2; 3]); %!test %! [m, f, c] = mode (x, 3); %! assert (reshape (m, [3, 3]), [1 2 1; 1 2 1; 1 2 1]); %! assert (reshape (f, [3, 3]), [1 2 1; 1 2 1; 1 2 1]); %! c = reshape (c, [3, 3]); %! assert (c{1}, [1; 2; 3]); %! assert (c{2}, [1; 2; 3]); %! assert (c{3}, [1; 2; 3]); %% Test input validation %!error mode () %!error mode (1, 2, 3) %!error mode ({1 2 3}) %!error mode (['A'; 'B']) %!error mode (1, ones (2,2)) %!error mode (1, 1.5) %!error mode (1, 0) %!error mode (1, 3)