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

annotate scripts/plot/triplot.m @ 14001:5f0bb45e615c

doc: Update documentation for functions returning a graphics handle h (Bug #34761) * voronoi.m, image.m, imagesc.m, imshow.m, area.m, bar.m, barh.m, clabel.m, clf.m, compass.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m, ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, findall.m, findobj.m, loglog.m, mesh.m, pareto.m, patch.m, pie.m, pie3.m, plot.m, polar.m, quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m, semilogx.m, semilogy.m, slice.m, stem.m, surf.m, surface.m, text.m, title.m, trimesh.m, triplot.m, trisurf.m, xlabel.m, ylabel.m, zlabel.m: Update documentation for functions returning a graphics handle h.

author	Rik <octave@nomad.inbox5.com>
date	Tue, 06 Dec 2011 13:09:17 -0800
parents	e8564e8b0043
children	22c50cbad2ce

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 10793 diff changeset	1 ## Copyright (C) 2007-2011 David Bateman
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	2 ##
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	3 ## This file is part of Octave.
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	4 ##
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: 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: 6826 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: 6826 diff changeset	8 ## your option) any later version.
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	9 ##
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	13 ## General Public License for more details.
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	14 ##
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: 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: 6826 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: 6826 diff changeset	17 ## <http://www.gnu.org/licenses/>.
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	18
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	19 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	20 ## @deftypefn {Function File} {} triplot (@var{tri}, @var{x}, @var{y})
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	21 ## @deftypefnx {Function File} {} triplot (@var{tri}, @var{x}, @var{y}, @var{linespec})
7650 eb7bdde776f2 Texinfo fixes John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	22 ## @deftypefnx {Function File} {@var{h} =} triplot (@dots{})
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	23 ## Plot a triangular mesh in 2D@. The variable @var{tri} is the triangular
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	24 ## meshing of the points @code{(@var{x}, @var{y})} which is returned from
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	25 ## @code{delaunay}. If given, @var{linespec} determines the properties
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13747 diff changeset	26 ## to use for the lines.
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13747 diff changeset	27 ##
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 13747 diff changeset	28 ## The optional return value @var{h} is a graphics handle to the created plot.
12187 87926ee23581 Add undocumented function trisurf to manual. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	29 ## @seealso{plot, trimesh, trisurf, delaunay}
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	30 ## @end deftypefn
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	31
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	32 function h = triplot (tri, x, y, varargin)
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	33
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	34 if (nargin < 3)
6826 8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	35 print_usage ();
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	36 endif
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	37
6826 8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	38 idx = tri(:, [1, 2, 3, 1]).';
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	39 nt = rows (tri);
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	40 handle = plot ([x(idx); NaN(1, nt)](:),
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	41 [y(idx); NaN(1, nt)](:), varargin{:});
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	42
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	43 if (nargout > 0)
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	44 h = handle;
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	45 endif
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	46
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	47 endfunction
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	48
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	49
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	50 %!demo
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	51 %! old_state = rand ("state");
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	52 %! restore_state = onCleanup (@() rand ("state", old_state));
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	53 %! rand ("state", 2);
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	54 %! N = 20;
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	55 %! x = rand (N, 1);
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	56 %! y = rand (N, 1);
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	57 %! tri = delaunay (x, y);
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	58 %! triplot (tri, x, y);
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 12792 diff changeset	59

Mercurial > octave-nkf

annotate scripts/plot/triplot.m @ 14001:5f0bb45e615c