Mercurial > hg > octave-lyh

annotate scripts/plot/ezpolar.m @ 14724:395d238418a7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Allow graphics_toolkit (h) to return the value for specified figures. * graphics_toolkit: Support "kits = graphics_toolkit (h)." Improve documentation. Modify test.
author Ben Abbott <bpabbott@mac.com>
date Mon, 04 Jun 2012 20:55:25 -0400
parents 9bb633cbdb96
children 78f57b14535c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14092
diff changeset
1 ## Copyright (C) 2007-2012 David Bateman
7337
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
2 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
4 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
8 ## your option) any later version.
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
9 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
14 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
18
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
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} {} ezpolar (@var{f})
7337
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefnx {Function File} {} ezpolar (@dots{}, @var{dom})
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {} ezpolar (@dots{}, @var{n})
14400
9bb633cbdb96 doc: Improve docstring for ezpolar.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
23 ## @deftypefnx {Function File} {} ezpolar (@var{hax}, @dots{})
7337
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} ezpolar (@dots{})
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
25 ##
14400
9bb633cbdb96 doc: Improve docstring for ezpolar.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
26 ## Plot a function in polar coordinates. The function @var{f} is
9bb633cbdb96 doc: Improve docstring for ezpolar.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
27 ## a string, inline function, or function handle with a single argument.
9bb633cbdb96 doc: Improve docstring for ezpolar.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
28 ## The expected form of the function is
9bb633cbdb96 doc: Improve docstring for ezpolar.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
29 ## @code{@var{rho} = @var{f}(@var{theta})}.
9bb633cbdb96 doc: Improve docstring for ezpolar.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
30 ## By default the plot is over the domain @code{0 < @var{theta} < 2*pi} with 60
9bb633cbdb96 doc: Improve docstring for ezpolar.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
31 ## points.
7337
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
32 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
33 ## If @var{dom} is a two element vector, it represents the minimum and maximum
14400
9bb633cbdb96 doc: Improve docstring for ezpolar.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
34 ## values of @var{theta}. @var{n} is a scalar defining the number of points to
9bb633cbdb96 doc: Improve docstring for ezpolar.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
35 ## use. If the optional input @var{hax} is given then the plot is placed into
9bb633cbdb96 doc: Improve docstring for ezpolar.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
36 ## the specified axes rather than the current axes.
7337
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
37 ##
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
38 ## The optional return value @var{h} is a graphics handle to the created plot.
7337
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
39 ##
14400
9bb633cbdb96 doc: Improve docstring for ezpolar.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
40 ## Example:
9bb633cbdb96 doc: Improve docstring for ezpolar.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
41 ##
7337
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
42 ## @example
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
43 ## ezpolar (@@(t) 1 + sin (t));
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
44 ## @end example
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
45 ##
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
46 ## @seealso{polar, ezplot, ezsurf, ezmesh}
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
47 ## @end deftypefn
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
48
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
49 function retval = ezpolar (varargin)
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
50
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
51 [h, needusage] = __ezplot__ ("polar", varargin{:});
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
52
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
53 if (needusage)
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
54 print_usage ();
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
55 endif
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
56
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
57 if (nargout > 0)
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
58 retval = h;
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
59 endif
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
60
7337
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
61 endfunction
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
62
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
63
7337
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
64 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
65 %! clf;
7337
e70789e0cd92 [project @ 2007-12-28 21:04:44 by jwe]
jwe
parents:
diff changeset
66 %! ezpolar (@(t) 1 + sin (t));
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
67