octave: scripts/general/sortrows.m annotate

annotate scripts/general/sortrows.m @ 20158:7503499a252b stable

doc: Update docstrings to have one sentence summary as first line. Update scripts in audio, elfun, general, geometry, and image directories. * scripts/audio/@audioplayer/__get_properties__.m, scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m, scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m, scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m, scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m, scripts/audio/@audiorecorder/audiorecorder.m, scripts/audio/@audiorecorder/get.m, scripts/audio/@audiorecorder/getaudiodata.m, scripts/audio/@audiorecorder/getplayer.m, scripts/audio/@audiorecorder/isrecording.m, scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m, scripts/audio/@audiorecorder/recordblocking.m, scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m, scripts/audio/@audiorecorder/subsasgn.m, scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m, scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m, scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m, scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m, scripts/general/accumarray.m, scripts/general/accumdim.m, scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m, scripts/general/blkdiag.m, scripts/general/cart2pol.m, scripts/general/cart2sph.m, scripts/general/cell2mat.m, scripts/general/celldisp.m, scripts/general/chop.m, scripts/general/circshift.m, scripts/general/common_size.m, scripts/general/cplxpair.m, scripts/general/cumtrapz.m, scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m, scripts/general/display.m, scripts/general/divergence.m, scripts/general/fieldnames.m, scripts/general/flip.m, scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m, scripts/general/gradient.m, scripts/general/interp3.m, scripts/general/interpft.m, scripts/general/interpn.m, scripts/general/loadobj.m, scripts/general/logspace.m, scripts/general/methods.m, scripts/general/nargchk.m, scripts/general/narginchk.m, scripts/general/nargoutchk.m, scripts/general/nextpow2.m, scripts/general/nthargout.m, scripts/general/num2str.m, scripts/general/pol2cart.m, scripts/general/polyarea.m, scripts/general/postpad.m, scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m, scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m, scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m, scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m, scripts/general/shiftdim.m, scripts/general/sortrows.m, scripts/general/sph2cart.m, scripts/general/structfun.m, scripts/general/subsindex.m, scripts/general/trapz.m, scripts/general/triplequad.m, scripts/geometry/delaunayn.m, scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m, scripts/geometry/griddata.m, scripts/geometry/griddata3.m, scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m, scripts/geometry/rectint.m, scripts/geometry/tsearchn.m, scripts/geometry/voronoi.m, scripts/geometry/voronoin.m, scripts/help/__unimplemented__.m, scripts/help/doc.m, scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m, scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m, scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m, scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m, scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m, scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m, scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m, scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m, scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m, scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m, scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m, scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m, scripts/image/white.m, scripts/image/winter.m: Update docstrings to have one sentence summary as first line. Re-structure to have line lengths <= 80 chars.

author	Rik <rik@octave.org>
date	Sun, 03 May 2015 09:36:20 -0700
parents	9fc020886ae9
children	516bb87ea72e e47eb34f1b05

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19593 diff changeset	1 ## Copyright (C) 2000-2015 Daniel Calvelo
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8455 diff changeset	2 ## Copyright (C) 2009 Jaroslav Hajek
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	3 ##
5181 41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	4 ## This file is part of Octave.
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	5 ##
5181 41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 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: 5443 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: 5443 diff changeset	9 ## your option) any later version.
5181 41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	10 ##
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	14 ## General Public License for more details.
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	15 ##
6758c11b5b99 [project @ 2005-03-03 05:18:04 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: 5443 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: 5443 diff changeset	18 ## <http://www.gnu.org/licenses/>.
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	19
5182 5b361aa47dff [project @ 2005-03-03 06:21:47 by jwe] jwe parents: 5181 diff changeset	20 ## -- texinfo --
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	21 ## @deftypefn {Function File} {[@var{s}, @var{i}] =} sortrows (@var{A})
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	22 ## @deftypefnx {Function File} {[@var{s}, @var{i}] =} sortrows (@var{A}, @var{c})
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	23 ## Sort the rows of the matrix @var{A} according to the order of the columns
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	24 ## specified in @var{c}.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	25 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	26 ## If @var{c} is omitted, a lexicographical sort is used. By default ascending
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	27 ## order is used however if elements of @var{c} are negative then the
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	28 ## corresponding column is sorted in descending order.
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	29 ## @seealso{sort}
5182 5b361aa47dff [project @ 2005-03-03 06:21:47 by jwe] jwe parents: 5181 diff changeset	30 ## @end deftypefn
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	31
5181 41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	32 ## Author: Daniel Calvelo, Paul Kienzle
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	33 ## Adapted-by: jwe
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	34
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10850 diff changeset	35 function [s, i] = sortrows (A, c)
7678 5988e08c1ae6 handle negative column values in sortrows Richard Bovey parents: 7017 diff changeset	36
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	37 if (nargin < 1 \|\| nargin > 2)
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	38 print_usage ();
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	39 endif
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	40
13293 007ebc128ab5 fix input validation for sortrows John W. Eaton <jwe@octave.org> parents: 13291 diff changeset	41 if (nargin == 2)
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	42 if (! (isnumeric (c) && isvector (c)))
13293 007ebc128ab5 fix input validation for sortrows John W. Eaton <jwe@octave.org> parents: 13291 diff changeset	43 error ("sortrows: C must be a numeric vector");
007ebc128ab5 fix input validation for sortrows John W. Eaton <jwe@octave.org> parents: 13291 diff changeset	44 elseif (any (c == 0) \|\| any (abs (c) > columns (A)))
007ebc128ab5 fix input validation for sortrows John W. Eaton <jwe@octave.org> parents: 13291 diff changeset	45 error ("sortrows: all elements of C must be in the range [1, columns (A)]");
007ebc128ab5 fix input validation for sortrows John W. Eaton <jwe@octave.org> parents: 13291 diff changeset	46 endif
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	47 endif
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	48
7678 5988e08c1ae6 handle negative column values in sortrows Richard Bovey parents: 7017 diff changeset	49 default_mode = "ascend";
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	50 reverse_mode = "descend";
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8455 diff changeset	51
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10850 diff changeset	52 if (issparse (A))
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	53 ## FIXME: Eliminate this case once __sort_rows_idx__ is fixed to
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	54 ## handle sparse matrices.
9669 63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	55 if (nargin == 1)
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	56 i = sort_rows_idx_generic (default_mode, reverse_mode, A);
9669 63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	57 else
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	58 i = sort_rows_idx_generic (default_mode, reverse_mode, A, c);
9669 63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	59 endif
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	60 elseif (nargin == 1)
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10850 diff changeset	61 i = __sort_rows_idx__ (A, default_mode);
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8455 diff changeset	62 elseif (all (c > 0))
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10850 diff changeset	63 i = __sort_rows_idx__ (A(:,c), default_mode);
8721 e9cb742df9eb imported patch sort3.diff Jaroslav Hajek <highegg@gmail.com> parents: 8455 diff changeset	64 elseif (all (c < 0))
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	65 i = __sort_rows_idx__ (A(:,-c), reverse_mode);
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	66 else
9669 63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	67 ## Otherwise, fall back to the old algorithm.
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	68 i = sort_rows_idx_generic (default_mode, reverse_mode, A, c);
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	69 endif
6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	70
10850 6c57bd7d0808 isargout optimization in sortrows Jaroslav Hajek <highegg@gmail.com> parents: 10549 diff changeset	71 ## Only bother to compute s if needed.
6c57bd7d0808 isargout optimization in sortrows Jaroslav Hajek <highegg@gmail.com> parents: 10549 diff changeset	72 if (isargout (1))
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10850 diff changeset	73 s = A(i,:);
10850 6c57bd7d0808 isargout optimization in sortrows Jaroslav Hajek <highegg@gmail.com> parents: 10549 diff changeset	74 endif
5181 41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	75
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	76 endfunction
7678 5988e08c1ae6 handle negative column values in sortrows Richard Bovey parents: 7017 diff changeset	77
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	78 function i = sort_rows_idx_generic (default_mode, reverse_mode, m, c)
9669 63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	79
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	80 if (nargin == 3)
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	81 indices = [1:columns(m)]';
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	82 mode(1:columns(m)) = {default_mode};
9669 63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	83 else
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	84 for j = 1:length (c);
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	85 if (c(j) < 0)
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	86 mode{j} = reverse_mode;
9669 63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	87 else
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	88 mode{j} = default_mode;
9669 63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	89 endif
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	90 endfor
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	91 indices = abs (c(:));
9669 63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	92 endif
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	93
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	94 ## Since sort is 'stable' the order of identical elements will be
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	95 ## preserved, so by traversing the sort indices in reverse order we
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	96 ## will make sure that identical elements in index i are subsorted by
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	97 ## index j.
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	98 indices = flipud (indices);
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	99 mode = flipud (mode');
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	100 i = [1:rows(m)]';
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	101 for j = 1:length (indices);
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	102 [~, idx] = sort (m(i, indices(j)), mode{j});
9669 63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	103 i = i(idx);
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	104 endfor
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	105
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	106 endfunction
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	107
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	108
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10850 diff changeset	109 %!test
9669 63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	110 %! m = [1, 1; 1, 2; 3, 6; 2, 7];
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	111 %! c = [1, -2];
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	112 %! [x, idx] = sortrows (m, c);
63249224f78d sortrows: also fall back on old algorithm for sparse matrices John W. Eaton <jwe@octave.org> parents: 9041 diff changeset	113 %! [sx, sidx] = sortrows (sparse (m), c);
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10850 diff changeset	114 %! assert (x, [1, 2; 1, 1; 2, 7; 3, 6]);
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10850 diff changeset	115 %! assert (idx, [2; 1; 4; 3]);
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10850 diff changeset	116 %! assert (issparse (sx));
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10850 diff changeset	117 %! assert (x, full (sx));
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10850 diff changeset	118 %! assert (idx, sidx);
12647 e38fb1910563 Allow sortrows to work on arrays with one row (bug #33197) John W. Eaton <jwe@octave.org> parents: 12639 diff changeset	119
e38fb1910563 Allow sortrows to work on arrays with one row (bug #33197) John W. Eaton <jwe@octave.org> parents: 12639 diff changeset	120 %!test
e38fb1910563 Allow sortrows to work on arrays with one row (bug #33197) John W. Eaton <jwe@octave.org> parents: 12639 diff changeset	121 %! m = [1, 0, 0, 4];
e38fb1910563 Allow sortrows to work on arrays with one row (bug #33197) John W. Eaton <jwe@octave.org> parents: 12639 diff changeset	122 %! c = 1;
e38fb1910563 Allow sortrows to work on arrays with one row (bug #33197) John W. Eaton <jwe@octave.org> parents: 12639 diff changeset	123 %! [x, idx] = sortrows (m, c);
e38fb1910563 Allow sortrows to work on arrays with one row (bug #33197) John W. Eaton <jwe@octave.org> parents: 12639 diff changeset	124 %! [sx, sidx] = sortrows (sparse (m), c);
e38fb1910563 Allow sortrows to work on arrays with one row (bug #33197) John W. Eaton <jwe@octave.org> parents: 12639 diff changeset	125 %! assert (x, m);
e38fb1910563 Allow sortrows to work on arrays with one row (bug #33197) John W. Eaton <jwe@octave.org> parents: 12639 diff changeset	126 %! assert (idx, 1);
e38fb1910563 Allow sortrows to work on arrays with one row (bug #33197) John W. Eaton <jwe@octave.org> parents: 12639 diff changeset	127 %! assert (issparse (sx));
e38fb1910563 Allow sortrows to work on arrays with one row (bug #33197) John W. Eaton <jwe@octave.org> parents: 12639 diff changeset	128 %! assert (x, full (sx));
e38fb1910563 Allow sortrows to work on arrays with one row (bug #33197) John W. Eaton <jwe@octave.org> parents: 12639 diff changeset	129 %! assert (idx, sidx);
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	130
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	131 ## Test input validation
13291 6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	132 %!error sortrows ()
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	133 %!error sortrows (1, 2, 3)
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	134 %!error sortrows (1, "ascend")
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	135 %!error sortrows (1, ones (2,2))
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	136 %!error sortrows (1, 0)
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	137 %!error sortrows (1, 2)
6cebb0c36b1d sortrows.m: Improve input validation and add more tests. Rik <octave@nomad.inbox5.com> parents: 12647 diff changeset	138

Mercurial > octave

annotate scripts/general/sortrows.m @ 20158:7503499a252b stable