Mercurial > octave

annotate scripts/plot/fplot.m @ 16338:8aeb5d5c3747

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fplot.m: Overhaul code to use modern coding practices. * scripts/plot/fplot.m: Use default values in function header. Use err variable rather than re-calculating it. Use fix rather than floor to test for an integer. Use name of bad argument in error() string. Correct indentation.
author Rik <rik@octave.org>
date Tue, 19 Mar 2013 16:00:09 -0700
parents 5d3a684236b0
children 5ec3f4aea91c
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) 2005-2012 Paul Kienzle
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
2 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
4 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
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: 6895
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: 6895
diff changeset
8 ## your option) any later version.
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
9 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
14 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
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: 6895
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: 6895
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
18
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
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} {} fplot (@var{fn}, @var{limits})
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
21 ## @deftypefnx {Function File} {} fplot (@var{fn}, @var{limits}, @var{tol})
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {} fplot (@var{fn}, @var{limits}, @var{n})
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6781
diff changeset
23 ## @deftypefnx {Function File} {} fplot (@dots{}, @var{fmt})
12632
2dbac27e0e40 doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
24 ## Plot a function @var{fn} within defined limits.
2dbac27e0e40 doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
25 ## @var{fn} is a function handle, inline function, or string
2dbac27e0e40 doc: miscellaneous touch-ups to documentation strings
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
26 ## containing the name of the function to evaluate.
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
27 ## The limits of the plot are given by @var{limits} of the form
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
28 ## @code{[@var{xlo}, @var{xhi}]} or @code{[@var{xlo}, @var{xhi},
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
29 ## @var{ylo}, @var{yhi}]}. @var{tol} is the default tolerance to use for the
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
30 ## plot, and if @var{tol} is an integer it is assumed that it defines the
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6781
diff changeset
31 ## number points to use in the plot. The @var{fmt} argument is passed
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6781
diff changeset
32 ## to the plot command.
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
33 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
34 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
35 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
36 ## fplot ("cos", [0, 2*pi])
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
37 ## fplot ("[cos(x), sin(x)]", [0, 2*pi])
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
38 ## @end group
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
39 ## @end example
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
40 ## @seealso{plot}
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
41 ## @end deftypefn
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
42
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
43 ## Author: Paul Kienzle <pkienzle@users.sf.net>
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
44
16338
8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents: 14868
diff changeset
45 function fplot (fn, limits, n = 0.002, fmt = "")
8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents: 14868
diff changeset
46
8847
4629e3925e75 fplot.m: fix nargin check
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
47 if (nargin < 2 || nargin > 4)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5820
diff changeset
48 print_usage ();
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
49 endif
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
50
16338
8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents: 14868
diff changeset
51 if (iscomplex (limits) || (numel (limits) != 2 && numel (limits) != 4))
8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents: 14868
diff changeset
52 error ("fplot: LIMITS must be a real vector with 2 or 4 elements");
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
53 endif
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
54
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
55 if (ischar (n))
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
56 fmt = n;
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
57 n = 0.002;
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
58 endif
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
59
6699
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
60 if (strcmp (typeinfo (fn), "inline function"))
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
61 fn = vectorize (fn);
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
62 nam = formula (fn);
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
63 elseif (isa (fn, "function_handle"))
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
64 nam = func2str (fn);
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
65 elseif (all (isalnum (fn)))
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
66 nam = fn;
10400
b14fd5116c29 Ensure that 'limits' is a 2 or 4 vector, and that 'fn' is a function
Soren Hauberg <hauberg@gmail.com>
parents: 9051
diff changeset
67 elseif (ischar (fn))
16338
8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents: 14868
diff changeset
68 fn = vectorize (inline (fn));
8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents: 14868
diff changeset
69 nam = formula (fn);
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
70 else
16338
8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents: 14868
diff changeset
71 error ("fplot: FN must be a function handle, inline function, or string");
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
72 endif
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
73
16338
8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents: 14868
diff changeset
74 if (n != fix (n))
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
75 tol = n;
7280
96f86c256ca0 [project @ 2007-12-10 21:12:51 by jwe]
jwe
parents: 7245
diff changeset
76 x0 = linspace (limits(1), limits(2), 5)';
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
77 y0 = feval (fn, x0);
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
78 err0 = Inf;
7280
96f86c256ca0 [project @ 2007-12-10 21:12:51 by jwe]
jwe
parents: 7245
diff changeset
79 n = 8;
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
80 x = linspace (limits(1), limits(2), n)';
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
81 y = feval (fn, x);
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
82
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
83 while (n < 2 .^ 20)
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
84 y00 = interp1 (x0, y0, x, "linear");
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
85 err = 0.5 * max (abs ((y00 - y) ./ (y00 + y))(:));
16338
8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents: 14868
diff changeset
86 if (err == err0 || err < tol)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10400
diff changeset
87 break;
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
88 endif
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
89 x0 = x;
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
90 y0 = y;
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
91 err0 = err;
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
92 n = 2 * (n - 1) + 1;
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
93 x = linspace (limits(1), limits(2), n)';
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
94 y = feval (fn, x);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
95 endwhile
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
96 else
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
97 x = linspace (limits(1), limits(2), n)';
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
98 y = feval (fn, x);
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
99 endif
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
100
16338
8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents: 14868
diff changeset
101 plot (x, y, fmt);
8145
7ef5b1b4e029 fplot.m: call axis after plot
John W. Eaton <jwe@octave.org>
parents: 7280
diff changeset
102
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
103 if (length (limits) > 2)
8145
7ef5b1b4e029 fplot.m: call axis after plot
John W. Eaton <jwe@octave.org>
parents: 7280
diff changeset
104 axis (limits);
7ef5b1b4e029 fplot.m: call axis after plot
John W. Eaton <jwe@octave.org>
parents: 7280
diff changeset
105 endif
7ef5b1b4e029 fplot.m: call axis after plot
John W. Eaton <jwe@octave.org>
parents: 7280
diff changeset
106
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8145
diff changeset
107 if (isvector (y))
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
108 legend (nam);
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
109 else
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8145
diff changeset
110 for i = 1:columns (y)
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
111 nams{i} = sprintf ("%s(:,%i)", nam, i);
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
112 endfor
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
113 legend (nams{:});
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
114 endif
16338
8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents: 14868
diff changeset
115
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
116 endfunction
7245
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7017
diff changeset
117
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7017
diff changeset
118
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe]
jwe
parents: 7017
diff changeset
119 %!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
120 %! clf;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
121 %! fplot ('cos', [0, 2*pi]);
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
122
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
123 %!demo
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
124 %! clf;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
125 %! fplot ('[cos(x), sin(x)]', [0, 2*pi]);
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
126