Mercurial > hg > octave-nkf

comparison scripts/general/rot90.m @ 12639:4d777e05d47c stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Review and update documentation for "Matrix Manipulation" chapter. * matrix.txi, arrayfun.m, blkdiag.m, fliplr.m, flipud.m, logspace.m, postpad.m, prepad.m, randi.m, repmat.m, rot90.m, rotdim.m, shiftdim.m, sortrows.m, vech.m, xor.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m, sylvester_matrix.m, toeplitz.m, vander.m, wilkinson.m, bsxfun.cc, find.cc, lookup.cc, rand.cc, tril.cc, data.cc, arrayfun.m, blkdiag.m, fliplr.m, flipud.m, logspace.m, postpad.m, prepad.m, randi.m, repmat.m, rot90.m, rotdim.m, shiftdim.m, sortrows.m, vech.m, xor.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m, sylvester_matrix.m, toeplitz.m, vander.m, wilkinson.m, bsxfun.cc (bsxfun), find.cc (find), lookup.cc (lookup), rand.cc (rand, randn, rande, randg, randp), tril.cc (triu), data.cc (all, any, horzcat, vertcat, cat, permute, ipermute, ones, zeros, eye, linspace, resize, reshape, issorted, diff): Improve docstrings
author Rik <octave@nomad.inbox5.com>
date Sun, 01 May 2011 08:55:15 -0700
parents c792872f8942
children a9d292ce5489
comparison
equal deleted inserted replaced
12637:d02798e9eeae 12639:4d777e05d47c
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} rot90 (@var{A}, @var{k}) 20 ## @deftypefn {Function File} {} rot90 (@var{A})
21 ## @deftypefnx {Function File} {} rot90 (@var{A}, @var{k})
21 ## Return a copy of @var{A} with the elements rotated counterclockwise in 22 ## Return a copy of @var{A} with the elements rotated counterclockwise in
22 ## 90-degree increments. The second argument is optional, and specifies 23 ## 90-degree increments. The second argument is optional, and specifies
23 ## how many 90-degree rotations are to be applied (the default value is 1). 24 ## how many 90-degree rotations are to be applied (the default value is 1).
24 ## Negative values of @var{k} rotate the matrix in a clockwise direction. 25 ## Negative values of @var{k} rotate the matrix in a clockwise direction.
25 ## For example, 26 ## For example,
42 ## rot90 ([1, 2; 3, 4], 3) 43 ## rot90 ([1, 2; 3, 4], 3)
43 ## rot90 ([1, 2; 3, 4], 7) 44 ## rot90 ([1, 2; 3, 4], 7)
44 ## @end group 45 ## @end group
45 ## @end example 46 ## @end example
46 ## 47 ##
47 ## Due to the difficulty of defining an axis about which to rotate the 48 ## Note that @code{rot90} only works with 2-D arrays. To rotate N-D arrays
48 ## matrix @code{rot90} only work with 2-D arrays. To rotate N-d arrays
49 ## use @code{rotdim} instead. 49 ## use @code{rotdim} instead.
50 ## @seealso{rotdim, flipud, fliplr, flipdim} 50 ## @seealso{rotdim, flipud, fliplr, flipdim}
51 ## @end deftypefn 51 ## @end deftypefn
52 52
53 ## Author: jwe 53 ## Author: jwe