annotate scripts/plot/fplot.m @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children d65670971cbc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 2005, 2006, 2007 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 -*-
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
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})
6699
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
24 ## Plot a function @var{fn}, within the defined limits. @var{fn}
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
25 ## an be either a string, a function handle or an inline function.
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
26 ## 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
27 ## @code{[@var{xlo}, @var{xhi}]} or @code{[@var{xlo}, @var{xhi},
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
28 ## @var{ylo}, @var{yhi}]}. @var{tol} is the default tolerance to use for the
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
29 ## 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
30 ## 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
31 ## to the plot command.
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
32 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
33 ## @example
6699
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
34 ## fplot ("cos", [0, 2*pi])
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
35 ## fplot ("[cos(x), sin(x)]", [0, 2*pi])
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
36 ## @end example
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
37 ## @seealso{plot}
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
38 ## @end deftypefn
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
39
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
40 ## Author: Paul Kienzle <pkienzle@users.sf.net>
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
41
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
42 function fplot (fn, limits, n, linespec)
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
43 if (nargin < 2 || nargin > 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5820
diff changeset
44 print_usage ();
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
45 endif
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
46
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
47 if (nargin < 3)
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
48 n = 0.002;
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
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
51 have_linespec = true;
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
52 if (nargin < 4)
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
53 have_linespec = false;
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
54 endif
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
55
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
56 if (ischar (n))
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
57 have_linespec = true;
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
58 linespec = n;
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
59 n = 0.002;
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
60 endif
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
61
6699
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
62 if (strcmp (typeinfo (fn), "inline function"))
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
63 fn = vectorize (fn);
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
64 nam = formula (fn);
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
65 elseif (isa (fn, "function_handle"))
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe]
jwe
parents: 6220
diff changeset
66 nam = func2str (fn);
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
67 elseif (all (isalnum (fn)))
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
68 nam = fn;
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
69 else
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
70 fn = vectorize (inline (fn));
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
71 nam = formula (fn);
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
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
74 if (floor(n) != n)
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
75 tol = n;
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
76 x0 = linspace (limits(1), limits(2), 3)';
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;
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
79 n = 5;
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))(:));
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
86 if (err == err0 || 0.5 * max (abs ((y00 - y) ./ (y00 + y))(:)) < tol)
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
87 break;
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);
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
95 endwhile
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
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
101 if (length (limits) > 2)
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
102 axis (limits);
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
103 endif
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
104
6781
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
105 if (have_linespec)
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
106 plot (x, y, linespec);
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
107 else
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
108 plot (x, y);
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
109 endif
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
110 if (isvector(y))
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
111 legend (nam);
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
112 else
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
113 for i=1:columns(y)
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
114 nams{i} = sprintf ("%s(:,%i)", nam, i);
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
115 endfor
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
116 legend (nams{:});
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman]
dbateman
parents: 6699
diff changeset
117 endif
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
118 endfunction