Mercurial > octave-antonio
view scripts/general/rotdim.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) 2004-2015 David Bateman ## ## 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} {} rotdim (@var{x}) ## @deftypefnx {Function File} {} rotdim (@var{x}, @var{n}) ## @deftypefnx {Function File} {} rotdim (@var{x}, @var{n}, @var{plane}) ## Return a copy of @var{x} with the elements rotated counterclockwise in ## 90-degree increments. ## ## The second argument @var{n} is optional, and specifies how many 90-degree ## rotations are to be applied (the default value is 1). Negative values of ## @var{n} rotate the matrix in a clockwise direction. ## ## The third argument is also optional and defines the plane of the rotation. ## If present, @var{plane} is a two element vector containing two different ## valid dimensions of the matrix. When @var{plane} is not given the first two ## non-singleton dimensions are used. ## ## For example, ## ## @example ## @group ## rotdim ([1, 2; 3, 4], -1, [1, 2]) ## @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 ## rotdim ([1, 2; 3, 4], -1, [1, 2]) ## rotdim ([1, 2; 3, 4], 3, [1, 2]) ## rotdim ([1, 2; 3, 4], 7, [1, 2]) ## @end group ## @end example ## @seealso{rot90, fliplr, flipud, flip} ## @end deftypefn function y = rotdim (x, n, plane) if (nargin < 1 || nargin > 3) print_usage (); endif if (nargin > 1 && ! isempty (n)) if (! isscalar (n) || ! isreal (n) || fix (n) != n) error ("rotdim: N must be a scalar integer"); endif else n = 1; endif nd = ndims (x); sz = size (x); if (nargin < 3) if (nd > 2) ## Find the first two non-singleton dimension. plane = []; dim = 0; while (dim < nd) dim = dim + 1; if (sz (dim) != 1) plane = [plane, dim]; if (length (plane) == 2) break; endif endif endwhile if (length (plane) < 1) plane = [1, 2]; elseif (length (plane) < 2) plane = [1, plane]; endif else plane = [1, 2]; endif else if (! (isvector (plane) && length (plane) == 2 && all (plane == fix (plane)) && all (plane > 0) && all (plane < (nd + 1)) && plane(1) != plane(2))) error ("rotdim: PLANE must be a 2 element integer vector defining a valid PLANE"); endif endif n = rem (n, 4); if (n < 0) n = n + 4; endif if (n == 0) y = x; elseif (n == 2) y = flip (flip (x, plane(1)), plane(2)); elseif (n == 1 || n == 3) perm = 1:nd; perm(plane(1)) = plane(2); perm(plane(2)) = plane(1); y = permute (x, perm); if (n == 1) y = flip (y, min (plane)); else y = flip (y, max (plane)); endif else error ("rotdim: internal error!"); endif endfunction %!shared r, rr %! r = [1,2,3]; rr = [3,2,1]; %!assert (rotdim (r, 0), r) %!assert (rotdim (r, 1), rr') %!assert (rotdim (r, 2), rr) %!assert (rotdim (r, 3), r') %!assert (rotdim (r, 3), rotdim (r, -1)) %!assert (rotdim (r, 1), rotdim (r)) %!shared c, cr %! c = [1;2;3]; cr = [3;2;1]; %!assert (rotdim (c, 0), c) %!assert (rotdim (c, 1), c') %!assert (rotdim (c, 2), cr) %!assert (rotdim (c, 3), cr') %!assert (rotdim (c, 3), rotdim (c, -1)) %!assert (rotdim (c, 1), rotdim (c)) %!shared m %! m = [1,2;3,4]; %!assert (rotdim (m, 0), m) %!assert (rotdim (m, 1), [2,4;1,3]) %!assert (rotdim (m, 2), [4,3;2,1]) %!assert (rotdim (m, 3), [3,1;4,2]) %!assert (rotdim (m, 3), rotdim (m, -1)) %!assert (rotdim (m, 1), rotdim (m)) ## FIXME: We need tests for multidimensional arrays ## and different values of PLANE. %!error rotdim () %!error rotdim (1, 2, 3, 4)