Mercurial > hg > octave-lyh
annotate scripts/general/fliplr.m @ 14138:72c96de7a403 stable
maint: update copyright notices for 2012
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Mon, 02 Jan 2012 14:25:41 -0500 |
| parents | 4d777e05d47c |
| children | f3d52523cde1 |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
12639
diff
changeset
|
1 ## Copyright (C) 1993-2012 John W. Eaton |
| 2313 | 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 | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 2313 | 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 | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 245 | 18 |
| 3369 | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} fliplr (@var{x}) | |
|
12639
4d777e05d47c
doc: Review and update documentation for "Matrix Manipulation" chapter.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
21 ## Return a copy of @var{x} with the order of the columns reversed. In |
|
4d777e05d47c
doc: Review and update documentation for "Matrix Manipulation" chapter.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
22 ## other words, @var{x} is flipped left-to-right about a vertical axis. For |
|
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
23 ## example: |
| 3426 | 24 ## |
| 3369 | 25 ## @example |
| 26 ## @group | |
| 27 ## fliplr ([1, 2; 3, 4]) | |
| 28 ## @result{} 2 1 | |
| 29 ## 4 3 | |
| 30 ## @end group | |
| 31 ## @end example | |
| 5053 | 32 ## |
|
12639
4d777e05d47c
doc: Review and update documentation for "Matrix Manipulation" chapter.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
33 ## Note that @code{fliplr} only works with 2-D arrays. To flip N-D arrays |
| 5053 | 34 ## use @code{flipdim} instead. |
| 5642 | 35 ## @seealso{flipud, flipdim, rot90, rotdim} |
| 3369 | 36 ## @end deftypefn |
| 4 | 37 |
| 2314 | 38 ## Author: jwe |
| 39 | |
| 2311 | 40 function y = fliplr (x) |
| 4 | 41 |
| 42 if (nargin != 1) | |
| 6046 | 43 print_usage (); |
| 4 | 44 endif |
| 45 | |
| 4869 | 46 if (ndims (x) > 2) |
| 8664 | 47 error ("fliplr: Only works with 2-D arrays"); |
| 4869 | 48 endif |
| 49 | |
| 4 | 50 nc = columns (x); |
| 51 y = x (:, nc:-1:1); | |
| 52 | |
| 53 endfunction | |
| 7411 | 54 |
| 55 %!assert((fliplr ([1, 2; 3, 4]) == [2, 1; 4, 3] | |
| 56 %! && fliplr ([1, 2; 3, 4; 5, 6]) == [2, 1; 4, 3; 6, 5] | |
| 57 %! && fliplr ([1, 2, 3; 4, 5, 6]) == [3, 2, 1; 6, 5, 4])); | |
| 58 | |
| 7940 | 59 %!error fliplr(); |
| 7411 | 60 |
| 61 %!error fliplr (1, 2); | |
| 62 |