Mercurial > octave-nkf
annotate scripts/general/flipdim.m @ 19439:cbce5d1bcaf9
doc: Periodic grammarcheck of documentation.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 16 Dec 2014 15:36:27 -0800 |
parents | 38b9849cd907 |
children | bf27e21f0bfb |
rev | line source |
---|---|
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
14363
diff
changeset
|
1 ## Copyright (C) 2004-2013 David Bateman |
9508 | 2 ## Copyright (C) 2009 VZLU Prague |
5012 | 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. | |
5012 | 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/>. | |
5012 | 19 |
20 ## -*- texinfo -*- | |
10692
b32a0214a464
Use > 1 test to find first non-singleton dimension rather than != 1.
Rik <octave@nomad.inbox5.com>
parents:
9510
diff
changeset
|
21 ## @deftypefn {Function File} {} flipdim (@var{x}) |
b32a0214a464
Use > 1 test to find first non-singleton dimension rather than != 1.
Rik <octave@nomad.inbox5.com>
parents:
9510
diff
changeset
|
22 ## @deftypefnx {Function File} {} flipdim (@var{x}, @var{dim}) |
19189
9220669832df
Undeprecate flipdim (prematurely deprecated in 995df67fc912).
Carnë Draug <carandraug@octave.org>
parents:
19160
diff
changeset
|
23 ## Flip array across specific dimension. |
5012 | 24 ## |
19189
9220669832df
Undeprecate flipdim (prematurely deprecated in 995df67fc912).
Carnë Draug <carandraug@octave.org>
parents:
19160
diff
changeset
|
25 ## This function is an alias for @code{flip} and exists for backwards |
19439
cbce5d1bcaf9
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
19190
diff
changeset
|
26 ## and @sc{matlab} compatibility. See further details about its usage |
19189
9220669832df
Undeprecate flipdim (prematurely deprecated in 995df67fc912).
Carnë Draug <carandraug@octave.org>
parents:
19160
diff
changeset
|
27 ## on @code{flip} help text. |
19160
995df67fc912
Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip.
Carnë Draug <carandraug+dev@gmail.com>
parents:
18891
diff
changeset
|
28 ## |
19189
9220669832df
Undeprecate flipdim (prematurely deprecated in 995df67fc912).
Carnë Draug <carandraug@octave.org>
parents:
19160
diff
changeset
|
29 ## @seealso{flip, fliplr, flipud, rot90, rotdim} |
5012 | 30 ## @end deftypefn |
31 | |
9508 | 32 ## Author: David Bateman, Jaroslav Hajek |
5012 | 33 |
19189
9220669832df
Undeprecate flipdim (prematurely deprecated in 995df67fc912).
Carnë Draug <carandraug@octave.org>
parents:
19160
diff
changeset
|
34 function y = flipdim (varargin) |
9220669832df
Undeprecate flipdim (prematurely deprecated in 995df67fc912).
Carnë Draug <carandraug@octave.org>
parents:
19160
diff
changeset
|
35 y = flip (varargin{:}); |
5012 | 36 endfunction |
19190
38b9849cd907
flipdim.m: Remove alias m-file from list of functions requiring %!tests.
Rik <rik@octave.org>
parents:
19189
diff
changeset
|
37 |
38b9849cd907
flipdim.m: Remove alias m-file from list of functions requiring %!tests.
Rik <rik@octave.org>
parents:
19189
diff
changeset
|
38 |
38b9849cd907
flipdim.m: Remove alias m-file from list of functions requiring %!tests.
Rik <rik@octave.org>
parents:
19189
diff
changeset
|
39 ## No tests needed for alias. All tests for functionality are in flip.m |
38b9849cd907
flipdim.m: Remove alias m-file from list of functions requiring %!tests.
Rik <rik@octave.org>
parents:
19189
diff
changeset
|
40 %!assert (1) |
38b9849cd907
flipdim.m: Remove alias m-file from list of functions requiring %!tests.
Rik <rik@octave.org>
parents:
19189
diff
changeset
|
41 |