Mercurial > octave-libgccjit
annotate scripts/general/flipud.m @ 10821:693e22af08ae
Grammarcheck documentation of m-files
Add newlines between @item fields for readability.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 26 Jul 2010 21:25:36 -0700 |
parents | eb63fbe60fab |
children | fd0a3ac60b0e |
rev | line source |
---|---|
7017 | 1 ## Copyright (C) 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2004, 2005, |
8920 | 2 ## 2006, 2007, 2008, 2009 John W. Eaton |
2313 | 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 | |
7016 | 8 ## the Free Software Foundation; either version 3 of the License, or (at |
9 ## your option) any later version. | |
2313 | 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 | |
7016 | 17 ## along with Octave; see the file COPYING. If not, see |
18 ## <http://www.gnu.org/licenses/>. | |
245 | 19 |
3369 | 20 ## -*- texinfo -*- |
21 ## @deftypefn {Function File} {} flipud (@var{x}) | |
22 ## Return a copy of @var{x} with the order of the rows reversed. 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 ## flipud ([1, 2; 3, 4]) | |
28 ## @result{} 3 4 | |
29 ## 1 2 | |
30 ## @end group | |
31 ## @end example | |
4869 | 32 ## |
33 ## Due to the difficulty of defining which axis about which to flip the | |
34 ## matrix @code{flipud} only work with 2-d arrays. To flip N-d arrays | |
35 ## use @code{flipdim} instead. | |
5642 | 36 ## @seealso{fliplr, flipdim, rot90, rotdim} |
3369 | 37 ## @end deftypefn |
4 | 38 |
2314 | 39 ## Author: jwe |
40 | |
2311 | 41 function y = flipud (x) |
4 | 42 |
43 if (nargin != 1) | |
6046 | 44 print_usage (); |
4 | 45 endif |
46 | |
4869 | 47 if (ndims (x) > 2) |
8664 | 48 error ("flipud: Only works with 2-d arrays"); |
4869 | 49 endif |
50 | |
4 | 51 nr = rows (x); |
52 y = x (nr:-1:1, :); | |
53 | |
54 endfunction | |
7411 | 55 |
56 %!assert((flipud ([1, 2; 3, 4]) == [3, 4; 1, 2] | |
57 %! && flipud ([1, 2; 3, 4; 5, 6]) == [5, 6; 3, 4; 1, 2] | |
58 %! && flipud ([1, 2, 3; 4, 5, 6]) == [4, 5, 6; 1, 2, 3])); | |
59 | |
60 %!error flipud (); | |
61 | |
62 %!error flipud (1, 2); | |
63 |