octave-lyh: scripts/plot/mesh.m annotate

annotate scripts/plot/mesh.m @ 16985:c9346014fed2

Validate inputs are real for mesh, meshc, meshz functions. Rename internal helper variables for greater clarity. * scripts/plot/mesh.m: Validate inputs are real. Use htmp for temporary handle. * scripts/plot/meshc.m: Validate inputs are real. Use htmp for temporary handle. * scripts/plot/meshz.m: Validate inputs are real. Use htmp for temporary handle. Use cellfun to replace for loop in input validation. Use oldax for saved axes handle.

author	Rik <rik@octave.org>
date	Sun, 14 Jul 2013 14:12:33 -0700
parents	ddac88d32d6a
children	328b579e08e9

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 14032 diff changeset	1 ## Copyright (C) 1993-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: 6405 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: 6405 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: 6405 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: 6405 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
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3063 diff changeset	19 ## -- texinfo --
11101 1f9ab076f5f7 Include the 4 input (color) in the docstrings for mesh() and surf(). Ben Abbott <bpabbott@mac.com> parents: 7149 diff changeset	20 ## @deftypefn {Function File} {} mesh (@var{x}, @var{y}, @var{z})
1f9ab076f5f7 Include the 4 input (color) in the docstrings for mesh() and surf(). Ben Abbott <bpabbott@mac.com> parents: 7149 diff changeset	21 ## @deftypefnx {Function File} {} mesh (@var{z})
1f9ab076f5f7 Include the 4 input (color) in the docstrings for mesh() and surf(). Ben Abbott <bpabbott@mac.com> parents: 7149 diff changeset	22 ## @deftypefnx {Function File} {} mesh (@dots{}, @var{c})
1f9ab076f5f7 Include the 4 input (color) in the docstrings for mesh() and surf(). Ben Abbott <bpabbott@mac.com> parents: 7149 diff changeset	23 ## @deftypefnx {Function File} {} mesh (@var{hax}, @dots{})
11563 3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	24 ## @deftypefnx {Function File} {@var{h} =} mesh (@dots{})
6154 08f0dabf17b9 [project @ 2006-11-13 18:30:25 by jwe] jwe parents: 6146 diff changeset	25 ## Plot a mesh given matrices @var{x}, and @var{y} from @code{meshgrid} and
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3063 diff changeset	26 ## a matrix @var{z} corresponding to the @var{x} and @var{y} coordinates of
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3063 diff changeset	27 ## the mesh. If @var{x} and @var{y} are vectors, then a typical vertex
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3063 diff changeset	28 ## is (@var{x}(j), @var{y}(i), @var{z}(i,j)). Thus, columns of @var{z}
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3063 diff changeset	29 ## correspond to different @var{x} values and rows of @var{z} correspond
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3063 diff changeset	30 ## to different @var{y} values.
11101 1f9ab076f5f7 Include the 4 input (color) in the docstrings for mesh() and surf(). Ben Abbott <bpabbott@mac.com> parents: 7149 diff changeset	31 ##
11575 d6619410e79c Spellcheck documentation before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11563 diff changeset	32 ## The color of the mesh is derived from the @code{colormap}
11563 3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	33 ## and the value of @var{z}. Optionally the color of the mesh can be
3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	34 ## specified independent of @var{z}, by adding a fourth matrix, @var{c}.
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11575 diff changeset	35 ##
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11575 diff changeset	36 ## The optional return value @var{h} is a graphics handle to the created
14032 8497d89a17f1 mesh.m: Correct typo in documentation Rik <octave@nomad.inbox5.com> parents: 14001 diff changeset	37 ## surface object.
11101 1f9ab076f5f7 Include the 4 input (color) in the docstrings for mesh() and surf(). Ben Abbott <bpabbott@mac.com> parents: 7149 diff changeset	38 ## @seealso{colormap, contour, meshgrid, surf}
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3063 diff changeset	39 ## @end deftypefn
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	40
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	41 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	42
7109 5436efbf35e3 [project @ 2007-11-06 22:16:25 by jwe] jwe parents: 7017 diff changeset	43 function h = mesh (varargin)
6172 2de853a110df [project @ 2006-11-15 22:53:47 by jwe] jwe parents: 6158 diff changeset	44
16985 c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	45 if (! all (cellfun ("isreal", varargin)))
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	46 error ("mesh: X, Y, Z, C arguments must be real");
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	47 endif
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	48
6390 334499d75c5c [project @ 2007-03-07 18:11:28 by jwe] jwe parents: 6257 diff changeset	49 newplot ();
334499d75c5c [project @ 2007-03-07 18:11:28 by jwe] jwe parents: 6257 diff changeset	50
16985 c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	51 htmp = surface (varargin{:});
7110 0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe] jwe parents: 7109 diff changeset	52
16985 c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	53 ax = get (htmp, "parent");
7110 0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe] jwe parents: 7109 diff changeset	54
16985 c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	55 set (htmp, "facecolor", "w");
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	56 set (htmp, "edgecolor", "flat");
7110 0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe] jwe parents: 7109 diff changeset	57
7146 c7e5e638a8d0 [project @ 2007-11-09 17:49:44 by jwe] jwe parents: 7110 diff changeset	58 if (! ishold ())
11427 dc983f92e774 contour3.m: Grid on be default for 3D plots. Ben Abbott <bpabbott@mac.com> parents: 11101 diff changeset	59 set (ax, "view", [-37.5, 30],
dc983f92e774 contour3.m: Grid on be default for 3D plots. Ben Abbott <bpabbott@mac.com> parents: 11101 diff changeset	60 "xgrid", "on", "ygrid", "on", "zgrid", "on");
7146 c7e5e638a8d0 [project @ 2007-11-09 17:49:44 by jwe] jwe parents: 7110 diff changeset	61 endif
7110 0e63f1126f01 [project @ 2007-11-06 22:36:22 by jwe] jwe parents: 7109 diff changeset	62
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6172 diff changeset	63 if (nargout > 0)
16985 c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	64 h = htmp;
6154 08f0dabf17b9 [project @ 2006-11-13 18:30:25 by jwe] jwe parents: 6146 diff changeset	65 endif
08f0dabf17b9 [project @ 2006-11-13 18:30:25 by jwe] jwe parents: 6146 diff changeset	66
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	67 endfunction
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11575 diff changeset	68
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11575 diff changeset	69
14411 b9630dfc4fd9 Add mesh() demos. Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	70 %!demo
16828 ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script. Rik <rik@octave.org> parents: 14868 diff changeset	71 %! clf;
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14412 diff changeset	72 %! x = logspace (0,1,11);
14411 b9630dfc4fd9 Add mesh() demos. Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	73 %! z = x'*x;
b9630dfc4fd9 Add mesh() demos. Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	74 %! mesh (x, x, z, z.^2);
16985 c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	75 %! xlabel 'X-axis';
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	76 %! ylabel 'Y-axis';
16828 ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script. Rik <rik@octave.org> parents: 14868 diff changeset	77 %! zlabel 'linear scale';
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11575 diff changeset	78
14411 b9630dfc4fd9 Add mesh() demos. Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	79 %!demo
16828 ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script. Rik <rik@octave.org> parents: 14868 diff changeset	80 %! clf;
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14412 diff changeset	81 %! x = logspace (0,1,11);
14411 b9630dfc4fd9 Add mesh() demos. Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	82 %! z = x'*x;
b9630dfc4fd9 Add mesh() demos. Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	83 %! mesh (x, x, z, z.^2);
16828 ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script. Rik <rik@octave.org> parents: 14868 diff changeset	84 %! set (gca, 'zscale', 'log');
16985 c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	85 %! xlabel 'X-axis';
c9346014fed2 Validate inputs are real for mesh, meshc, meshz functions. Rik <rik@octave.org> parents: 16828 diff changeset	86 %! ylabel 'Y-axis';
16828 ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script. Rik <rik@octave.org> parents: 14868 diff changeset	87 %! zlabel 'log scale';
ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script. Rik <rik@octave.org> parents: 14868 diff changeset	88 %! if (strcmp (get (gcf, '__graphics_toolkit__'), 'gnuplot'))
ddac88d32d6a Make demos in plot m-files compatible with Matlab for running comparison script. Rik <rik@octave.org> parents: 14868 diff changeset	89 %! title ({'Gnuplot: mesh color is wrong', 'This a Gnuplot bug'});
14411 b9630dfc4fd9 Add mesh() demos. Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	90 %! endif
b9630dfc4fd9 Add mesh() demos. Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	91

Mercurial > hg > octave-lyh

annotate scripts/plot/mesh.m @ 16985:c9346014fed2