annotate scripts/general/flipdim.m @ 5018:1c65a8e44ef9 ss-2-1-59

[project @ 2004-09-22 03:33:29 by jwe]
author jwe
date Wed, 22 Sep 2004 03:33:29 +0000
parents ed25bed43409
children c08cb1098afc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5012
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2004 David Bateman
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
2 ##
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
4 ##
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
5 ## 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
6 ## under the terms of the GNU General Public License as published by
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
9 ##
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
14 ##
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
18 ## 02111-1307, USA.
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 -*-
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefn {Function File} {} flipdim (@var{x}, @var{dim})
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
22 ## Return a copy of @var{x} flipped about the dimension @var{dim}.
5018
1c65a8e44ef9 [project @ 2004-09-22 03:33:29 by jwe]
jwe
parents: 5012
diff changeset
23 ## For example
5012
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
24 ##
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
25 ## @example
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
26 ## @group
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
27 ## flipdim ([1, 2; 3, 4], 2)
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
28 ## @result{} 2 1
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
29 ## 4 3
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
30 ## @end group
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
31 ## @end example
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
32 ## @end deftypefn
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
33 ## @seealso{fliplr, flipud, rot90 and rotdim}
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
34
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
35 ## Author: David Bateman
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
36
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
37 function y = flipdim (x, dim)
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 if (nargin != 1 && nargin != 2)
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
40 usage ("flipdim (x, dim)");
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
41 endif
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
42
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
43 nd = ndims (x);
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
44 sz = size (x);
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
45 if (nargin == 1)
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
46 ## Find the first non-singleton dimension.
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
47 dim = 1;
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
48 while (dim < nd + 1 && sz(dim) == 1)
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
49 dim = dim + 1;
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
50 endwhile
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
51 if (dim > nd)
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
52 dim = 1;
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
53 endif
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
54 else
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
55 if (! (isscalar (dim) && dim == round (dim)) && dim > 0 && dim < (nd + 1))
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
56 error ("flipdim: dim must be an integer and valid dimension");
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
57 endif
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
58 endif
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
59
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
60 idx = cell ();
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
61 for i = 1:nd
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
62 idx{i} = 1:sz(i);
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
63 endfor
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
64 idx{dim} = sz(dim):-1:1;
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
65 y = x(idx{:});
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
66
ed25bed43409 [project @ 2004-09-21 15:45:48 by jwe]
jwe
parents:
diff changeset
67 endfunction