update packages

[CreaPhase.git] / octave_packages / m / general / fliplr.m

diff --git a/octave_packages/m/general/fliplr.m b/octave_packages/m/general/fliplr.m
new file mode 100644 (file)
index 0000000..580c64d
--- /dev/null
+++ b/octave_packages/m/general/fliplr.m
@@ -0,0 +1,62 @@
+## Copyright (C) 1993-2012 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} {} fliplr (@var{x})
+## Return a copy of @var{x} with the order of the columns reversed.  In
+## other words, @var{x} is flipped left-to-right about a vertical axis.  For
+## example:
+##
+## @example
+## @group
+## fliplr ([1, 2; 3, 4])
+##      @result{}  2  1
+##          4  3
+## @end group
+## @end example
+##
+## Note that @code{fliplr} only works with 2-D arrays.  To flip N-D arrays
+## use @code{flipdim} instead.
+## @seealso{flipud, flipdim, rot90, rotdim}
+## @end deftypefn
+
+## Author: jwe
+
+function y = fliplr (x)
+
+  if (nargin != 1)
+    print_usage ();
+  endif
+
+  if (ndims (x) > 2)
+    error ("fliplr: Only works with 2-D arrays");
+  endif
+
+  nc = columns (x);
+  y = x (:, nc:-1:1);
+
+endfunction
+
+%!assert((fliplr ([1, 2; 3, 4]) == [2, 1; 4, 3]
+%! && fliplr ([1, 2; 3, 4; 5, 6]) == [2, 1; 4, 3; 6, 5]
+%! && fliplr ([1, 2, 3; 4, 5, 6]) == [3, 2, 1; 6, 5, 4]));
+
+%!error fliplr();
+
+%!error fliplr (1, 2);
+