annotate scripts/general/rot90.m @ 5540:cda6a105ae9a before-ov-branch

[project @ 2005-11-17 05:47:13 by jwe]
author jwe
date Thu, 17 Nov 2005 05:47:13 +0000
parents cfd5e4cad7b4
children 2618a0750ae6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2314
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## under the terms of the GNU General Public License as published by
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
8 ## any later version.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5053
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5053
diff changeset
18 ## 02110-1301, USA.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
19
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
20 ## -*- texinfo -*-
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
21 ## @deftypefn {Function File} {} rot90 (@var{x}, @var{n})
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
22 ## Return a copy of @var{x} with the elements rotated counterclockwise in
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
23 ## 90-degree increments. The second argument is optional, and specifies
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
24 ## how many 90-degree rotations are to be applied (the default value is 1).
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
25 ## Negative values of @var{n} rotate the matrix in a clockwise direction.
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
26 ## For example,
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
27 ##
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
28 ## @example
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
29 ## @group
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
30 ## rot90 ([1, 2; 3, 4], -1)
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
31 ## @result{} 3 1
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
32 ## 4 2
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
33 ## @end group
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
34 ## @end example
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
35 ##
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
36 ## @noindent
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
37 ## rotates the given matrix clockwise by 90 degrees. The following are all
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
38 ## equivalent statements:
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
39 ##
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
40 ## @example
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
41 ## @group
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
42 ## rot90 ([1, 2; 3, 4], -1)
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
43 ## rot90 ([1, 2; 3, 4], 3)
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
44 ## rot90 ([1, 2; 3, 4], 7)
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
45 ## @end group
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
46 ## @end example
4869
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
47 ##
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
48 ## Due to the difficulty of defining an axis about which to rotate the
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
49 ## matrix @code{rot90} only work with 2-D arrays. To rotate N-d arrays
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
50 ## use @code{rotdim} instead.
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
51 ## @end deftypefn
5053
c08cb1098afc [project @ 2004-10-19 23:10:54 by jwe]
jwe
parents: 4869
diff changeset
52 ##
4869
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
53 ## @seealso{rotdim, flipud, fliplr and flipdim}
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
54
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
55 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
56
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
57 function y = rot90 (x, k)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
58
4869
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
59 if (nargin == 1 || nargin == 2)
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
60 if (nargin < 2)
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
61 k = 1;
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
62 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
63
4869
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
64 if (ndims (x) > 2)
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
65 error ("rot90: Only works with 2-D arrays")
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
66 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
67
4869
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
68 if (imag (k) != 0 || fix (k) != k)
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
69 error ("rot90: k must be an integer");
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
70 endif
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
71
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
72 k = rem (k, 4);
4869
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
73
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
74 if (k < 0)
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
75 k = k + 4;
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
76 endif
4869
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
77
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
78 if (k == 0)
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
79 y = x;
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
80 elseif (k == 1)
3238
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 2847
diff changeset
81 y = flipud (x.');
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
82 elseif (k == 2)
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
83 y = flipud (fliplr (x));
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
84 elseif (k == 3)
3238
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 2847
diff changeset
85 y = (flipud (x)).';
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
86 else
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
87 error ("rot90: internal error!");
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
88 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
89 else
3456
434790acb067 [project @ 2000-01-19 06:58:51 by jwe]
jwe
parents: 3426
diff changeset
90 usage ("rot90 (x, k)");
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
91 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
92
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
93 endfunction