Mercurial > octave-antonio
view scripts/general/rot90.m @ 20158:7503499a252b stable
doc: Update docstrings to have one sentence summary as first line.
Update scripts in audio, elfun, general, geometry, and image directories.
* scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m,
scripts/audio/@audiorecorder/subsasgn.m,
scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m,
scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m,
scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m,
scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m,
scripts/general/accumarray.m, scripts/general/accumdim.m,
scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m,
scripts/general/blkdiag.m, scripts/general/cart2pol.m,
scripts/general/cart2sph.m, scripts/general/cell2mat.m,
scripts/general/celldisp.m, scripts/general/chop.m,
scripts/general/circshift.m, scripts/general/common_size.m,
scripts/general/cplxpair.m, scripts/general/cumtrapz.m,
scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m,
scripts/general/display.m, scripts/general/divergence.m,
scripts/general/fieldnames.m, scripts/general/flip.m,
scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m,
scripts/general/gradient.m, scripts/general/interp3.m,
scripts/general/interpft.m, scripts/general/interpn.m,
scripts/general/loadobj.m, scripts/general/logspace.m,
scripts/general/methods.m, scripts/general/nargchk.m,
scripts/general/narginchk.m, scripts/general/nargoutchk.m,
scripts/general/nextpow2.m, scripts/general/nthargout.m,
scripts/general/num2str.m, scripts/general/pol2cart.m,
scripts/general/polyarea.m, scripts/general/postpad.m,
scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m,
scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m,
scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m,
scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m,
scripts/general/shiftdim.m, scripts/general/sortrows.m,
scripts/general/sph2cart.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/trapz.m,
scripts/general/triplequad.m, scripts/geometry/delaunayn.m,
scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m,
scripts/geometry/rectint.m, scripts/geometry/tsearchn.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/help/__unimplemented__.m, scripts/help/doc.m,
scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m,
scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m,
scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m,
scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m,
scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m,
scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m,
scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m,
scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m,
scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m,
scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m,
scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m,
scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m,
scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m,
scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m,
scripts/image/white.m, scripts/image/winter.m:
Update docstrings to have one sentence summary as first line.
Re-structure to have line lengths <= 80 chars.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 09:36:20 -0700 |
parents | 9fc020886ae9 |
children |
line wrap: on
line source
## Copyright (C) 1993-2015 John W. Eaton ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} rot90 (@var{A}) ## @deftypefnx {Function File} {} rot90 (@var{A}, @var{k}) ## Rotate array by 90 degree increments. ## ## Return a copy of @var{A} with the elements rotated counterclockwise in ## 90-degree increments. ## ## The second argument is optional, and specifies how many 90-degree rotations ## are to be applied (the default value is 1). Negative values of @var{k} ## rotate the matrix in a clockwise direction. ## For example, ## ## @example ## @group ## rot90 ([1, 2; 3, 4], -1) ## @result{} 3 1 ## 4 2 ## @end group ## @end example ## ## @noindent ## rotates the given matrix clockwise by 90 degrees. The following are all ## equivalent statements: ## ## @example ## @group ## rot90 ([1, 2; 3, 4], -1) ## rot90 ([1, 2; 3, 4], 3) ## rot90 ([1, 2; 3, 4], 7) ## @end group ## @end example ## ## The rotation is always performed on the plane of the first two dimensions, ## i.e., rows and columns. To perform a rotation on any other plane, use ## @code{rotdim}. ## ## @seealso{rotdim, fliplr, flipud, flip} ## @end deftypefn ## Author: jwe function B = rot90 (A, k = 1) if (nargin < 1 || nargin > 2) print_usage (); endif if (! (isscalar (k) && isreal (k) && k == fix (k))) error ("rot90: K must be a single real integer"); endif k = mod (k, 4); nd = ndims (A); if (k == 0) B = A; elseif (k == 1) B = flipud (permute (A, [2 1 3:1:nd])); elseif (k == 2) idx(1:nd) = {':'}; idx{1} = rows (A):-1:1; idx{2} = columns (A):-1:1; B = A(idx{:}); elseif (k == 3) B = permute (flipud (A), [2 1 3:1:nd]); else error ("rot90: internal error!"); endif endfunction %!test %! x1 = [1, 2; 3, 4]; %! x2 = [2, 4; 1, 3]; %! x3 = [4, 3; 2, 1]; %! x4 = [3, 1; 4, 2]; %! %! assert (rot90 (x1), x2); %! assert (rot90 (x1, 2), x3); %! assert (rot90 (x1, 3), x4); %! assert (rot90 (x1, 4), x1); %! assert (rot90 (x1, 5), x2); %! assert (rot90 (x1, -1), x4); ## Test NDArrays %!test %! a(1:2,1:2,1) = [1 2; 3 4]; %! a(1:2,1:2,2) = [5 6; 7 8]; %! b(1:2,1:2,1) = [2 4; 1 3]; %! b(1:2,1:2,2) = [6 8; 5 7]; %! assert (rot90 (a, 1), b) %! assert (rot90 (a, 2), rot90 (b, 1)) %! assert (rot90 (a, 3), rot90 (b, 2)) %!test %! a = b = zeros (2, 2, 1, 2); %! a(1:2,1:2,:,1) = [1 2; 3 4]; %! a(1:2,1:2,:,2) = [5 6; 7 8]; %! b(1:2,1:2,:,1) = [2 4; 1 3]; %! b(1:2,1:2,:,2) = [6 8; 5 7]; %! assert (rot90 (a, 1), b) %! assert (rot90 (a, 2), rot90 (b, 1)) %! assert (rot90 (a, 3), rot90 (b, 2)) ## With non-square matrices %!test %! a = zeros (3, 2, 1, 2); %! b = zeros (2, 3, 1, 2); %! a(1:2,1:3,:,1) = [ 1 2 3; 4 5 6]; %! a(1:2,1:3,:,2) = [ 7 8 9; 10 11 12]; %! b(1:3,1:2,:,1) = [ 3 6; 2 5; 1 4]; %! b(1:3,1:2,:,2) = [ 9 12; 8 11; 7 10]; %! assert (rot90 (a, 1), b) %! assert (rot90 (a, 2), rot90 (b, 1)) %! assert (rot90 (a, 3), rot90 (b, 2)) ## Test input validation %!error rot90 () %!error rot90 (1, 2, 3) %!error rot90 (1, ones (2)) %!error rot90 (1, 1.5) %!error rot90 (1, 1+i)