Mercurial > octave-antonio

comparison scripts/deprecated/flipdim.m @ 19126:995df67fc912

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. * fliplr.m, flipud.m: add support for N-dimensional arrays by making use of flip(). Added new tests for ND arrays and defaults. * flipdim.m: deprecate in favour of new function flip() which has exactly the same syntax and is part of Matlab since R2014a. * flip.m: new function copied from flipdim. Added tests for ND arrays and defaults. * matrix.txi: replace flipdim DOCSTRINg with flip. * rot90.m, rotdim.m, del2.m: replace flipdim() with flip() * NEWS: note deprecation of flip(), new function flipdim(), and ND support for flipud() and fliplr().
author Carnë Draug <carandraug+dev@gmail.com>
date Sun, 21 Sep 2014 18:49:08 +0100
parents scripts/general/flipdim.m@7bbe3658c5ef
children
comparison
equal deleted inserted replaced
19125:62f833acf183 19126:995df67fc912
1 ## Copyright (C) 2004-2013 David Bateman
2 ## Copyright (C) 2009 VZLU Prague
3 ##
4 ## This file is part of Octave.
5 ##
6 ## Octave is free software; you can redistribute it and/or modify it
7 ## under the terms of the GNU General Public License as published by
8 ## the Free Software Foundation; either version 3 of the License, or (at
9 ## your option) any later version.
10 ##
11 ## Octave is distributed in the hope that it will be useful, but
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 ## General Public License for more details.
15 ##
16 ## You should have received a copy of the GNU General Public License
17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>.
19
20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {} flipdim (@var{x})
22 ## @deftypefnx {Function File} {} flipdim (@var{x}, @var{dim})
23 ## Return a copy of @var{x} flipped about the dimension @var{dim}.
24 ## @var{dim} defaults to the first non-singleton dimension.
25 ##
26 ## @strong{Warning:} @code{flipdim} is scheduled for removal in version 4.6.
27 ## Use @code{flip} which can be used as a drop-in replacement.
28 ##
29 ## @seealso{fliplr, flipud, rot90, rotdim}
30 ## @end deftypefn
31
32 ## Author: David Bateman, Jaroslav Hajek
33
34 function y = flipdim (x, dim)
35
36 persistent warned = false;
37 if (! warned)
38 warned = true;
39 warning ("Octave:deprecated-function",
40 "flipdim is deprecated and will be removed from a future version of Octave; please use flip (x, dim) instead");
41 endif
42
43 if (nargin != 1 && nargin != 2)
44 print_usage ();
45 endif
46
47 nd = ndims (x);
48 sz = size (x);
49 if (nargin == 1)
50 ## Find the first non-singleton dimension.
51 (dim = find (sz > 1, 1)) || (dim = 1);
52 elseif (! (isscalar (dim) && isindex (dim)))
53 error ("flipdim: DIM must be a positive integer");
54 endif
55
56 idx(1:max(nd, dim)) = {':'};
57 idx{dim} = size (x, dim):-1:1;
58 y = x(idx{:});
59
60 endfunction
61