annotate scripts/general/rot90.m @ 7948:af10baa63915 ss-3-1-50

3.1.50 snapshot
author John W. Eaton <jwe@octave.org>
date Fri, 18 Jul 2008 17:42:48 -0400
parents 83a8781b529d
children e07e93c04080
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2004, 2005,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## 2006, 2007 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## 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
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.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## 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
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## 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
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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/>.
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.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5488
diff changeset
51 ## @seealso{rotdim, flipud, fliplr, flipdim}
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3238
diff changeset
52 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
53
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
54 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
55
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
56 function y = rot90 (x, k)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
57
4869
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
58 if (nargin == 1 || nargin == 2)
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
59 if (nargin < 2)
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
60 k = 1;
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
61 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
62
4869
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
63 if (ndims (x) > 2)
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
64 error ("rot90: Only works with 2-D arrays")
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
65 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
66
4869
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
67 if (imag (k) != 0 || fix (k) != k)
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
68 error ("rot90: k must be an integer");
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
69 endif
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
70
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
71 k = rem (k, 4);
4869
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
72
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
73 if (k < 0)
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
74 k = k + 4;
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
75 endif
4869
b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe]
jwe
parents: 3456
diff changeset
76
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
77 if (k == 0)
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
78 y = x;
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
79 elseif (k == 1)
3238
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 2847
diff changeset
80 y = flipud (x.');
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
81 elseif (k == 2)
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
82 y = flipud (fliplr (x));
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
83 elseif (k == 3)
3238
041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe]
jwe
parents: 2847
diff changeset
84 y = (flipud (x)).';
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
85 else
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
86 error ("rot90: internal error!");
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
87 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
88 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
89 print_usage ();
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
90 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
91
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
92 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
93
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
94 %!test
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
95 %! x1 = [1, 2;
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
96 %! 3, 4];
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
97 %! x2 = [2, 4;
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
98 %! 1, 3];
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
99 %! x3 = [4, 3;
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
100 %! 2, 1];
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
101 %! x4 = [3, 1;
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
102 %! 4, 2];
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
103 %!
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
104 %! assert((rot90 (x1)== x2 && rot90 (x1, 2) == x3 && rot90 (x1, 3) == x4
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
105 %! && rot90 (x1, 4) == x1 && rot90 (x1, 5) == x2 && rot90 (x1, -1) == x4));
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
106
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
107 %!error rot90 ();
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
108
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
109 %!error rot90 (1, 2, 3);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
110