octave-nkf: scripts/general/flipud.m annotate

annotate scripts/general/flipud.m @ 19318:995df67fc912

Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. * fliplr.m, flipud.m: add support for N-dimensional arrays by making use of flip(). Added new tests for ND arrays and defaults. * flipdim.m: deprecate in favour of new function flip() which has exactly the same syntax and is part of Matlab since R2014a. * flip.m: new function copied from flipdim. Added tests for ND arrays and defaults. * matrix.txi: replace flipdim DOCSTRINg with flip. * rot90.m, rotdim.m, del2.m: replace flipdim() with flip() * NEWS: note deprecation of flip(), new function flipdim(), and ND support for flipud() and fliplr().

author	Carnë Draug <carandraug+dev@gmail.com>
date	Sun, 21 Sep 2014 18:49:08 +0100
parents	d63878346099
children	76baa2d10abb

rev	line source
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 14363 diff changeset	1 ## Copyright (C) 1993-2013 John W. Eaton
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	8 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	17 ## <http://www.gnu.org/licenses/>.
245 16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe] jwe parents: 4 diff changeset	18
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 2847 diff changeset	19 ## -- texinfo --
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 2847 diff changeset	20 ## @deftypefn {Function File} {} flipud (@var{x})
19318 995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	21 ## Flip array upside down.
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	22 ##
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	23 ## Return a copy of @var{x} with the order of the rows reversed. In
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	24 ## other words, @var{x} is flipped upside-down about a horizontal axis. For
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 8920 diff changeset	25 ## example:
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3420 diff changeset	26 ##
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 2847 diff changeset	27 ## @example
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 2847 diff changeset	28 ## @group
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 2847 diff changeset	29 ## flipud ([1, 2; 3, 4])
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 2847 diff changeset	30 ## @result{} 3 4
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 2847 diff changeset	31 ## 1 2
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 2847 diff changeset	32 ## @end group
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 2847 diff changeset	33 ## @end example
4869 b92d59213e63 [project @ 2004-04-21 17:03:02 by jwe] jwe parents: 3426 diff changeset	34 ##
19318 995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	35 ## @seealso{fliplr, rot90, rotdim}
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 2847 diff changeset	36 ## @end deftypefn
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	37
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	38 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	39
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	40 function y = flipud (x)
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	41
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	42 if (nargin != 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	43 print_usage ();
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	44 endif
19318 995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	45 y = flip (x, 1);
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	46
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	47 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	48
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	49
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	50 %!assert (flipud ([1, 2; 3, 4]), [3, 4; 1, 2])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	51 %!assert (flipud ([1, 2; 3, 4; 5, 6]), [5, 6; 3, 4; 1, 2])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	52 %!assert (flipud ([1, 2, 3; 4, 5, 6]), [4, 5, 6; 1, 2, 3])
19318 995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	53 %!assert (flipud ([1 2 3]), [1 2 3])
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	54
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	55 ## Test NDArrays
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	56 %!test
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	57 %! a(:,:,1) = [ 1 2 3; 4 5 6];
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	58 %! a(:,:,2) = [ 7 8 9; 10 11 12];
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	59 %! b(:,:,1) = [ 4 5 6; 1 2 3];
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	60 %! b(:,:,2) = [10 11 12; 7 8 9];
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	61 %! assert (flipud (a), b)
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	62
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	63 ## Test NDArray with singleton dimensions
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	64 %!test
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	65 %! a(:,:,:,1) = [ 1 2 3; 4 5 6];
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	66 %! a(:,:,:,2) = [ 7 8 9; 10 11 12];
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	67 %! b(:,:,:,1) = [ 4 5 6; 1 2 3];
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	68 %! b(:,:,:,2) = [10 11 12; 7 8 9];
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	69 %! assert (flipud (a), b)
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	70
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	71 ## Test for 1 row, i.e., returns the same
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	72 %!test
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	73 %! a(1,:,:,1) = [ 1 2 3 4];
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	74 %! a(1,:,:,2) = [ 5 6 7 8];
995df67fc912 Flip arrays - ND support for fliplr and flipud, and replace flipdim with flip. Carnë Draug <carandraug+dev@gmail.com> parents: 17744 diff changeset	75 %! assert (flipud (a), a)
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	76
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	77 %!error flipud ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	78 %!error flipud (1, 2)
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	79

Mercurial > hg > octave-nkf

annotate scripts/general/flipud.m @ 19318:995df67fc912