octave-nkf: scripts/general/flipdim.m annotate

annotate scripts/general/flipdim.m @ 18891:7bbe3658c5ef

maint: Use "FIXME:" coding convention in m-files. * flipdim.m, prepad.m, rotdim.m, doc.m, strread.m, textread.m, krylov.m, colon.m, dump_prefs.m, fileattrib.m, getappdata.m, __xzip__.m, unpack.m, fsolve.m, axis.m, meshc.m, print.m, __ghostscript__.m, __go_draw_axes__.m, __print_parse_opts__.m, struct2hdl.m, unique.m, spstats.m, treeplot.m, test.m, datestr.m: Use "FIXME:" coding convention in m-files.

author	Rik <rik@octave.org>
date	Wed, 25 Jun 2014 13:45:41 -0700
parents	d63878346099
children

rev	line source
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 14363 diff changeset	1 ## Copyright (C) 2004-2013 David Bateman
9508 e5e4e404a59d simplify flipdim Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	2 ## Copyright (C) 2009 VZLU Prague
5012 ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	3 ##
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	4 ## This file is part of Octave.
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	5 ##
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: 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: 6046 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: 6046 diff changeset	9 ## your option) any later version.
5012 ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	10 ##
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	14 ## General Public License for more details.
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	15 ##
ed25bed43409 [project @ 2004-09-21 15:45:48 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: 6046 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: 6046 diff changeset	18 ## <http://www.gnu.org/licenses/>.
5012 ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	19
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	20 ## -- texinfo --
10692 b32a0214a464 Use > 1 test to find first non-singleton dimension rather than != 1. Rik <octave@nomad.inbox5.com> parents: 9510 diff changeset	21 ## @deftypefn {Function File} {} flipdim (@var{x})
b32a0214a464 Use > 1 test to find first non-singleton dimension rather than != 1. Rik <octave@nomad.inbox5.com> parents: 9510 diff changeset	22 ## @deftypefnx {Function File} {} flipdim (@var{x}, @var{dim})
5012 ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	23 ## Return a copy of @var{x} flipped about the dimension @var{dim}.
10692 b32a0214a464 Use > 1 test to find first non-singleton dimension rather than != 1. Rik <octave@nomad.inbox5.com> parents: 9510 diff changeset	24 ## @var{dim} defaults to the first non-singleton dimension.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10790 diff changeset	25 ## For example:
5012 ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	26 ##
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	27 ## @example
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	28 ## @group
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	29 ## flipdim ([1, 2; 3, 4], 2)
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	30 ## @result{} 2 1
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	31 ## 4 3
5012 ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	32 ## @end group
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	33 ## @end example
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5307 diff changeset	34 ## @seealso{fliplr, flipud, rot90, rotdim}
5012 ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	35 ## @end deftypefn
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	36
9508 e5e4e404a59d simplify flipdim Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	37 ## Author: David Bateman, Jaroslav Hajek
5012 ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	38
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	39 function y = flipdim (x, dim)
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	40
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	41 if (nargin != 1 && nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	42 print_usage ();
5012 ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	43 endif
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	44
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	45 nd = ndims (x);
12796 886256714823 codesprint: Correct missing comma in tests for flipdim.m Rik <octave@nomad.inbox5.com> parents: 12795 diff changeset	46 sz = size (x);
5012 ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	47 if (nargin == 1)
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	48 ## Find the first non-singleton dimension.
12674 9493880928c8 Use common idiom in m-files for finding first non-singleton dimension. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	49 (dim = find (sz > 1, 1)) \|\| (dim = 1);
10790 01f1643dfbb1 fix flipdim with trailing singleton dims Jaroslav Hajek <highegg@gmail.com> parents: 10692 diff changeset	50 elseif (! (isscalar (dim) && isindex (dim)))
01f1643dfbb1 fix flipdim with trailing singleton dims Jaroslav Hajek <highegg@gmail.com> parents: 10692 diff changeset	51 error ("flipdim: DIM must be a positive integer");
5012 ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	52 endif
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	53
10790 01f1643dfbb1 fix flipdim with trailing singleton dims Jaroslav Hajek <highegg@gmail.com> parents: 10692 diff changeset	54 idx(1:max(nd, dim)) = {':'};
9508 e5e4e404a59d simplify flipdim Jaroslav Hajek <highegg@gmail.com> parents: 7017 diff changeset	55 idx{dim} = size (x, dim):-1:1;
5012 ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	56 y = x(idx{:});
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	57
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe] jwe parents: diff changeset	58 endfunction
12795 9e7ebbaf69ff codesprint: new tests for files in scripts/general directory John W. Eaton <jwe@octave.org> parents: 12674 diff changeset	59
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory John W. Eaton <jwe@octave.org> parents: 12674 diff changeset	60
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	61 %!assert (flipdim ([1,2;3,4]), flipdim ([1,2 ; 3,4], 1))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	62 %!assert (flipdim ([1,2;3,4], 2), [2,1;4,3])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	63 %!assert (flipdim ([1,2;3,4], 3), [1,2;3,4])
12795 9e7ebbaf69ff codesprint: new tests for files in scripts/general directory John W. Eaton <jwe@octave.org> parents: 12674 diff changeset	64
18891 7bbe3658c5ef maint: Use "FIXME:" coding convention in m-files. Rik <rik@octave.org> parents: 17744 diff changeset	65 ## FIXME: We need tests for multidimensional arrays.
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	66
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	67 %!error flipdim ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	68 %!error flipdim (1, 2, 3)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	69

Mercurial > octave-nkf

annotate scripts/general/flipdim.m @ 18891:7bbe3658c5ef