X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=octave_packages%2Fm%2Fgeneral%2Fflipdim.m;fp=octave_packages%2Fm%2Fgeneral%2Fflipdim.m;h=cb633214b4c69449c0a51923f14507fbfd516b2c;hb=1c0469ada9531828709108a4882a751d2816994a;hp=0000000000000000000000000000000000000000;hpb=63de9f36673d49121015e3695f2c336ea92bc278;p=CreaPhase.git diff --git a/octave_packages/m/general/flipdim.m b/octave_packages/m/general/flipdim.m new file mode 100644 index 0000000..cb63321 --- /dev/null +++ b/octave_packages/m/general/flipdim.m @@ -0,0 +1,67 @@ +## Copyright (C) 2004-2012 David Bateman +## Copyright (C) 2009 VZLU Prague +## +## 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 +## . + +## -*- texinfo -*- +## @deftypefn {Function File} {} flipdim (@var{x}) +## @deftypefnx {Function File} {} flipdim (@var{x}, @var{dim}) +## Return a copy of @var{x} flipped about the dimension @var{dim}. +## @var{dim} defaults to the first non-singleton dimension. +## For example: +## +## @example +## @group +## flipdim ([1, 2; 3, 4], 2) +## @result{} 2 1 +## 4 3 +## @end group +## @end example +## @seealso{fliplr, flipud, rot90, rotdim} +## @end deftypefn + +## Author: David Bateman, Jaroslav Hajek + +function y = flipdim (x, dim) + + if (nargin != 1 && nargin != 2) + print_usage (); + endif + + nd = ndims (x); + sz = size (x); + if (nargin == 1) + ## Find the first non-singleton dimension. + (dim = find (sz > 1, 1)) || (dim = 1); + elseif (! (isscalar (dim) && isindex (dim))) + error ("flipdim: DIM must be a positive integer"); + endif + + idx(1:max(nd, dim)) = {':'}; + idx{dim} = size (x, dim):-1:1; + y = x(idx{:}); + +endfunction + +%!error flipdim (); +%!error flipdim (1, 2, 3); + +%!assert (flipdim ([1,2;3,4]), flipdim ([1,2 ; 3,4], 1)); +%!assert (flipdim ([1,2;3,4], 2), [2,1;4,3]); +%!assert (flipdim ([1,2;3,4], 3), [1,2;3,4]); + +## FIXME -- we need tests for multidimensional arrays.