octave_packages/m/general/flipud.m

   1 ## Copyright (C) 1993-2012 John W. Eaton
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} flipud (@var{x})
  21 ## Return a copy of @var{x} with the order of the rows reversed.  In
  22 ## other words, @var{x} is flipped upside-down about a horizontal axis.  For
  23 ## example:
  24 ##
  25 ## @example
  26 ## @group
  27 ## flipud ([1, 2; 3, 4])
  28 ##      @result{}  3  4
  29 ##          1  2
  30 ## @end group
  31 ## @end example
  32 ##
  33 ## Note that @code{flipud} only works with 2-D arrays.  To flip N-D arrays
  34 ## use @code{flipdim} instead.
  35 ## @seealso{fliplr, flipdim, rot90, rotdim}
  36 ## @end deftypefn
  37
  38 ## Author: jwe
  39
  40 function y = flipud (x)
  41
  42   if (nargin != 1)
  43     print_usage ();
  44   endif
  45
  46   if (ndims (x) > 2)
  47     error ("flipud: Only works with 2-d arrays");
  48   endif
  49
  50   nr = rows (x);
  51   y = x (nr:-1:1, :);
  52
  53 endfunction
  54
  55 %!assert((flipud ([1, 2; 3, 4]) == [3, 4; 1, 2]
  56 %! && flipud ([1, 2; 3, 4; 5, 6]) == [5, 6; 3, 4; 1, 2]
  57 %! && flipud ([1, 2, 3; 4, 5, 6]) == [4, 5, 6; 1, 2, 3]));
  58
  59 %!error flipud ();
  60
  61 %!error flipud (1, 2);
  62