octave-nkf: scripts/plot/meshgrid.m annotate

annotate scripts/plot/meshgrid.m @ 16033:23a7661e529a ss-3-7-2

snapshot version 3.7.2 * configure.ac (AC_INIT): Set version to 3.7.2. (OCTAVE_RELEASE_DATE): Set to 2013-02-09. (OCTAVE_COPYRIGHT): Update year.

author	John W. Eaton <jwe@octave.org>
date	Sun, 10 Feb 2013 00:59:19 -0500
parents	f3d52523cde1
children	eaab03308c0b

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13263 diff changeset	1 ## Copyright (C) 1996-2012 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: 6813 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: 6813 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: 6813 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: 6813 diff changeset	17 ## <http://www.gnu.org/licenses/>.
1713 d9e42d0bab09 [project @ 1996-01-08 02:22:55 by jwe] jwe parents: diff changeset	18
3407 5e0a0b1cba43 [project @ 2000-01-06 03:13:55 by jwe] jwe parents: 2847 diff changeset	19 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	20 ## @deftypefn {Function File} {[@var{xx}, @var{yy}, @var{zz}] =} meshgrid (@var{x}, @var{y}, @var{z})
5378 b2a5596a3f7b [project @ 2005-06-02 16:01:25 by jwe] jwe parents: 5307 diff changeset	21 ## @deftypefnx {Function File} {[@var{xx}, @var{yy}] =} meshgrid (@var{x}, @var{y})
3439 3234a698073a [project @ 2000-01-14 09:51:14 by jwe] jwe parents: 3408 diff changeset	22 ## @deftypefnx {Function File} {[@var{xx}, @var{yy}] =} meshgrid (@var{x})
5717 34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	23 ## Given vectors of @var{x} and @var{y} and @var{z} coordinates, and
9209 923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction. Rik <rdrider0-list@yahoo.com> parents: 7017 diff changeset	24 ## returning 3 arguments, return three-dimensional arrays corresponding
5717 34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	25 ## to the @var{x}, @var{y}, and @var{z} coordinates of a mesh. When
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	26 ## returning only 2 arguments, return matrices corresponding to the
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	27 ## @var{x} and @var{y} coordinates of a mesh. The rows of @var{xx} are
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	28 ## copies of @var{x}, and the columns of @var{yy} are copies of @var{y}.
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	29 ## If @var{y} is omitted, then it is assumed to be the same as @var{x},
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	30 ## and @var{z} is assumed the same as @var{y}.
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5390 diff changeset	31 ## @seealso{mesh, contour}
3407 5e0a0b1cba43 [project @ 2000-01-06 03:13:55 by jwe] jwe parents: 2847 diff changeset	32 ## @end deftypefn
1713 d9e42d0bab09 [project @ 1996-01-08 02:22:55 by jwe] jwe parents: diff changeset	33
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	34 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	35
5378 b2a5596a3f7b [project @ 2005-06-02 16:01:25 by jwe] jwe parents: 5307 diff changeset	36 function [xx, yy, zz] = meshgrid (x, y, z)
1713 d9e42d0bab09 [project @ 1996-01-08 02:22:55 by jwe] jwe parents: diff changeset	37
5717 34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	38 if (nargin == 0 \|\| nargin > 3)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5717 diff changeset	39 print_usage ();
5717 34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	40 endif
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	41
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	42 if (nargin < 2)
1713 d9e42d0bab09 [project @ 1996-01-08 02:22:55 by jwe] jwe parents: diff changeset	43 y = x;
d9e42d0bab09 [project @ 1996-01-08 02:22:55 by jwe] jwe parents: diff changeset	44 endif
5717 34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	45
6813 75d99621f850 [project @ 2007-08-14 17:14:18 by jwe] jwe parents: 6046 diff changeset	46 ## Use repmat to ensure that the result values have the same type as
75d99621f850 [project @ 2007-08-14 17:14:18 by jwe] jwe parents: 6046 diff changeset	47 ## the arguments.
75d99621f850 [project @ 2007-08-14 17:14:18 by jwe] jwe parents: 6046 diff changeset	48
5717 34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	49 if (nargout < 3)
4030 22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe] jwe parents: 3803 diff changeset	50 if (isvector (x) && isvector (y))
6813 75d99621f850 [project @ 2007-08-14 17:14:18 by jwe] jwe parents: 6046 diff changeset	51 xx = repmat (x(:).', length (y), 1);
75d99621f850 [project @ 2007-08-14 17:14:18 by jwe] jwe parents: 6046 diff changeset	52 yy = repmat (y(:), 1, length (x));
1713 d9e42d0bab09 [project @ 1996-01-08 02:22:55 by jwe] jwe parents: diff changeset	53 else
d9e42d0bab09 [project @ 1996-01-08 02:22:55 by jwe] jwe parents: diff changeset	54 error ("meshgrid: arguments must be vectors");
d9e42d0bab09 [project @ 1996-01-08 02:22:55 by jwe] jwe parents: diff changeset	55 endif
d9e42d0bab09 [project @ 1996-01-08 02:22:55 by jwe] jwe parents: diff changeset	56 else
5717 34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	57 if (nargin < 3)
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	58 z = y;
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	59 endif
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	60 if (isvector (x) && isvector (y) && isvector (z))
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	61 lenx = length (x);
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	62 leny = length (y);
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	63 lenz = length (z);
6813 75d99621f850 [project @ 2007-08-14 17:14:18 by jwe] jwe parents: 6046 diff changeset	64 xx = repmat (repmat (x(:).', leny, 1), [1, 1, lenz]);
75d99621f850 [project @ 2007-08-14 17:14:18 by jwe] jwe parents: 6046 diff changeset	65 yy = repmat (repmat (y(:), 1, lenx), [1, 1, lenz]);
5717 34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	66 zz = reshape (repmat (z(:).', lenx*leny, 1)(:), leny, lenx, lenz);
34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	67 else
6813 75d99621f850 [project @ 2007-08-14 17:14:18 by jwe] jwe parents: 6046 diff changeset	68 error ("meshgrid: arguments must be vectors");
5717 34cda7d94c08 [project @ 2006-03-27 22:26:18 by jwe] jwe parents: 5642 diff changeset	69 endif
1713 d9e42d0bab09 [project @ 1996-01-08 02:22:55 by jwe] jwe parents: diff changeset	70 endif
d9e42d0bab09 [project @ 1996-01-08 02:22:55 by jwe] jwe parents: diff changeset	71
d9e42d0bab09 [project @ 1996-01-08 02:22:55 by jwe] jwe parents: diff changeset	72 endfunction
13263 a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	73
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	74
13263 a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	75 %!test
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	76 %! x = 1:2;
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	77 %! y = 1:3;
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	78 %! z = 1:4;
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	79 %! [XX, YY, ZZ] = meshgrid (x, y, z);
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	80 %! assert (size_equal (XX, YY, ZZ));
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	81 %! assert (ndims (XX), 3);
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	82 %! assert (size (XX), [3, 2, 4]);
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	83 %! assert (XX(1) * YY(1) * ZZ(1), x(1) * y(1) * z(1));
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	84 %! assert (XX(end) * YY(end) * ZZ(end), x(end) * y(end) * z(end));
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	85
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	86 %!test
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	87 %! x = 1:2;
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	88 %! y = 1:3;
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	89 %! [XX, YY] = meshgrid (x, y);
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	90 %! assert (size_equal (XX, YY));
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	91 %! assert (ndims (XX), 2);
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	92 %! assert (size (XX), [3, 2]);
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	93 %! assert (XX(1) * YY(1), x(1) * y(1));
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	94 %! assert (XX(end) * YY(end), x(end) * y(end));
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	95
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	96 %!test
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	97 %! x = 1:3;
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	98 %! [XX1, YY1] = meshgrid (x, x);
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	99 %! [XX2, YY2] = meshgrid (x);
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	100 %! assert (size_equal (XX1, XX2, YY1, YY2));
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	101 %! assert (ndims (XX1), 2);
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	102 %! assert (size (XX1), [3, 3]);
a156263b5509 Add tests for meshgrid and ndgrid. Kai Habel <kai.habel@gmx.de> parents: 11523 diff changeset	103 %! assert (XX1, XX2);
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	104 %! assert (YY1, YY2);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	105

Mercurial > octave-nkf

annotate scripts/plot/meshgrid.m @ 16033:23a7661e529a ss-3-7-2