Mercurial > octave
annotate scripts/plot/draw/fplot.m @ 24431:0c6cedafc71e stable
doc: Use 'axes' rather than 'axis' appropriately in docstrings.
* voronoi.m, axis.m, box.m, caxis.m, datetick.m, grid.m, legend.m,
lighting.m, shading.m, title.m, view.m, xlabel.m, xlim.m, ylabel.m, ylim.m,
zlabel.m, zlim.m, area.m, bar.m, barh.m, colorbar.m, comet.m, comet3.m,
compass.m, contour.m, contour3.m, contourf.m, cylinder.m, ellipsoid.m,
errorbar.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m,
ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, fplot.m, hist.m,
line.m, loglog.m, loglogerr.m, mesh.m, meshc.m, meshz.m, pareto.m, patch.m,
pcolor.m, pie.m, pie3.m, plot.m, plot3.m, plotmatrix.m, plotyy.m, polar.m,
quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m,
semilogx.m, semilogxerr.m, semilogy.m, semilogyerr.m, slice.m, sphere.m,
stairs.m, stem.m, stem3.m, surf.m, surface.m, surfc.m, surfl.m, surfnorm.m,
waterfall.m, axes.m, cla.m, gca.m, hold.m, newplot.m, subplot.m:
Use 'axes' rather than 'axis' appropriately in docstrings.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 19 Dec 2017 12:39:25 -0800 |
parents | 3ac9f9ecfae5 |
children | 6cf385e26616 dc6404ab6947 |
rev | line source |
---|---|
23219
3ac9f9ecfae5
maint: Update copyright dates.
John W. Eaton <jwe@octave.org>
parents:
23083
diff
changeset
|
1 ## Copyright (C) 2005-2017 Paul Kienzle |
5820 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
5820 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
5820 | 18 |
19 ## -*- texinfo -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20715
diff
changeset
|
20 ## @deftypefn {} {} fplot (@var{fn}, @var{limits}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20715
diff
changeset
|
21 ## @deftypefnx {} {} fplot (@dots{}, @var{tol}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20715
diff
changeset
|
22 ## @deftypefnx {} {} fplot (@dots{}, @var{n}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20715
diff
changeset
|
23 ## @deftypefnx {} {} fplot (@dots{}, @var{fmt}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20715
diff
changeset
|
24 ## @deftypefnx {} {[@var{x}, @var{y}] =} fplot (@dots{}) |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
25 ## Plot a function @var{fn} within the range defined by @var{limits}. |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
26 ## |
17479 | 27 ## @var{fn} is a function handle, inline function, or string containing the |
28 ## name of the function to evaluate. | |
29 ## | |
30 ## The limits of the plot are of the form @w{@code{[@var{xlo}, @var{xhi}]}} or | |
31 ## @w{@code{[@var{xlo}, @var{xhi}, @var{ylo}, @var{yhi}]}}. | |
32 ## | |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
33 ## The next three arguments are all optional and any number of them may be |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
34 ## given in any order. |
17479 | 35 ## |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
36 ## @var{tol} is the relative tolerance to use for the plot and defaults |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
37 ## to 2e-3 (.2%). |
17479 | 38 ## |
39 ## @var{n} is the minimum number of points to use. When @var{n} is specified, | |
40 ## the maximum stepsize will be @code{@var{xhi} - @var{xlo} / @var{n}}. More | |
41 ## than @var{n} points may still be used in order to meet the relative | |
42 ## tolerance requirement. | |
43 ## | |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
44 ## The @var{fmt} argument specifies the linestyle to be used by the plot |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
45 ## command. |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
46 ## |
24431
0c6cedafc71e
doc: Use 'axes' rather than 'axis' appropriately in docstrings.
Rik <rik@octave.org>
parents:
23219
diff
changeset
|
47 ## If the first argument @var{hax} is an axes handle, then plot into this axes, |
17159
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
48 ## rather than the current axes returned by @code{gca}. |
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
49 ## |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
50 ## With no output arguments the results are immediately plotted. With two |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
51 ## output arguments the 2-D plot data is returned. The data can subsequently |
16951
a7c9be4a2c0f
fplot.m: Fix bad texinfo in docstring for changeset b34202b24212.
Rik <rik@octave.org>
parents:
16950
diff
changeset
|
52 ## be plotted manually with @code{plot (@var{x}, @var{y})}. |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
53 ## |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
54 ## Example: |
5820 | 55 ## |
56 ## @example | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
57 ## @group |
16951
a7c9be4a2c0f
fplot.m: Fix bad texinfo in docstring for changeset b34202b24212.
Rik <rik@octave.org>
parents:
16950
diff
changeset
|
58 ## fplot (@@cos, [0, 2*pi]) |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
59 ## 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
|
60 ## @end group |
5820 | 61 ## @end example |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
62 ## |
20205
59911f536b07
fplot.m: Document requirement of accepting vector inputs (bug #42050).
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
63 ## Programming Notes: |
59911f536b07
fplot.m: Document requirement of accepting vector inputs (bug #42050).
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
64 ## |
59911f536b07
fplot.m: Document requirement of accepting vector inputs (bug #42050).
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
65 ## @code{fplot} works best with continuous functions. Functions with |
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17026
diff
changeset
|
66 ## discontinuities are unlikely to plot well. This restriction may be removed |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17026
diff
changeset
|
67 ## in the future. |
20205
59911f536b07
fplot.m: Document requirement of accepting vector inputs (bug #42050).
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
68 ## |
59911f536b07
fplot.m: Document requirement of accepting vector inputs (bug #42050).
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
69 ## @code{fplot} requires that the function accept and return a vector argument. |
59911f536b07
fplot.m: Document requirement of accepting vector inputs (bug #42050).
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
70 ## Consider this when writing user-defined functions and use @code{.*}, |
59911f536b07
fplot.m: Document requirement of accepting vector inputs (bug #42050).
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
71 ## @code{./}, etc. See the function @code{vectorize} for potentially |
59911f536b07
fplot.m: Document requirement of accepting vector inputs (bug #42050).
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
72 ## converting inline or anonymous functions to vectorized versions. |
20715
5b7643257978
Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents:
20205
diff
changeset
|
73 ## |
20205
59911f536b07
fplot.m: Document requirement of accepting vector inputs (bug #42050).
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
74 ## @seealso{ezplot, plot, vectorize} |
5820 | 75 ## @end deftypefn |
76 | |
7017 | 77 ## Author: Paul Kienzle <pkienzle@users.sf.net> |
78 | |
17159
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
79 function [X, Y] = fplot (varargin) |
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
80 |
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
81 [hax, varargin, nargin] = __plt_get_axis_arg__ ("fplot", varargin{:}); |
5820 | 82 |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
83 if (nargin < 2 || nargin > 5) |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
84 print_usage (); |
6781 | 85 endif |
86 | |
17159
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
87 fn = varargin{1}; |
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
88 limits = varargin{2}; |
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
89 varargin = varargin(3:end); |
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
90 |
6699 | 91 if (strcmp (typeinfo (fn), "inline function")) |
92 fn = vectorize (fn); | |
93 nam = formula (fn); | |
94 elseif (isa (fn, "function_handle")) | |
95 nam = func2str (fn); | |
5820 | 96 elseif (all (isalnum (fn))) |
6781 | 97 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
|
98 elseif (ischar (fn)) |
16338
8aeb5d5c3747
fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
99 fn = vectorize (inline (fn)); |
8aeb5d5c3747
fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
100 nam = formula (fn); |
5820 | 101 else |
16338
8aeb5d5c3747
fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
102 error ("fplot: FN must be a function handle, inline function, or string"); |
6781 | 103 endif |
104 | |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
105 if (iscomplex (limits) || (numel (limits) != 2 && numel (limits) != 4)) |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
106 error ("fplot: LIMITS must be a real vector with 2 or 4 elements"); |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
107 endif |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
108 |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
109 n = 5; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
110 tol = 2e-3; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
111 fmt = ""; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
112 for i = 1:numel (varargin) |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
113 arg = varargin{i}; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
114 if (ischar (arg)) |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
115 fmt = arg; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
116 elseif (isnumeric (arg) && isscalar (arg) && arg > 0) |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
117 if (arg == fix (arg)) |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
118 n = arg; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
119 else |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
120 tol = arg; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
121 endif |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
122 else |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
123 error ("fplot: bad input in position %d", i+2); |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
124 endif |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
125 endfor |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
126 |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
18629
diff
changeset
|
127 if (n != 5) |
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
18629
diff
changeset
|
128 ## n was specified |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
129 x0 = linspace (limits(1), limits(2), n/2 + 1)'; |
6781 | 130 y0 = feval (fn, x0); |
131 x = linspace (limits(1), limits(2), n)'; | |
132 y = feval (fn, x); | |
133 else | |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
134 x0 = linspace (limits(1), limits(2), 5)'; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
135 y0 = feval (fn, x0); |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
136 n = 8; |
6781 | 137 x = linspace (limits(1), limits(2), n)'; |
138 y = feval (fn, x); | |
5820 | 139 endif |
140 | |
21831
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
141 if (rows (x0) == rows (y0)) |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
142 fcn_transpose = false; |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
143 elseif (rows (x0) == columns (y0)) |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
144 fcn_transpose = true; |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
145 y0 = y0.'; |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
146 y = y.'; |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
147 elseif (isscalar (y0)) |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
148 ## FN is a constant value function |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
149 y0 = repmat (y0, size (x0)); |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
150 y = repmat (y, size (x)); |
21831
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
151 else |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
152 error ("fplot: invalid function FN (# of outputs not equal to inputs)"); |
8145
7ef5b1b4e029
fplot.m: call axis after plot
John W. Eaton <jwe@octave.org>
parents:
7280
diff
changeset
|
153 endif |
7ef5b1b4e029
fplot.m: call axis after plot
John W. Eaton <jwe@octave.org>
parents:
7280
diff
changeset
|
154 |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
155 err0 = Inf; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
156 |
21831
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
157 ## FIXME: This algorithm should really use adaptive scaling as |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
158 ## the numerical quadrature algorithms do so that extra points are |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
159 ## used where they are needed and not spread evenly over the entire |
17479 | 160 ## x-range. Try any function with a discontinuity, such as |
161 ## fplot (@tan, [-2, 2]) or fplot ("1./x", [-3, 2]), to see the | |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
162 ## problems with the current solution. |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
163 |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
164 while (n < 2^18) # Something is wrong if we need more than 250K points |
18629
6fdd3ab55b78
undo unintended changes to fplot in changeset 37c300acfcfd
John W. Eaton <jwe@octave.org>
parents:
18627
diff
changeset
|
165 yi = interp1 (x0, y0, x, "linear"); |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
166 ## relative error calculation using average of [yi,y] as reference |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
167 ## since neither estimate is known a priori to be better than the other. |
18629
6fdd3ab55b78
undo unintended changes to fplot in changeset 37c300acfcfd
John W. Eaton <jwe@octave.org>
parents:
18627
diff
changeset
|
168 err = 0.5 * max (abs ((yi - y) ./ (yi + y))(:)); |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
169 if (err < tol || abs (err - err0) < tol/2) |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
170 ## Either relative tolerance has been met OR |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
171 ## algorithm has stopped making any reasonable progress per iteration. |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
172 break; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
173 endif |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
174 x0 = x; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
175 y0 = y; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
176 err0 = err; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
177 n = 2 * (n - 1) + 1; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
178 x = linspace (limits(1), limits(2), n)'; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
179 y = feval (fn, x); |
21831
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
180 if (fcn_transpose) |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
181 y = y.'; |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
182 endif |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
183 endwhile |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
184 |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
185 if (nargout == 2) |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
186 X = x; |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
187 Y = y; |
6781 | 188 else |
17159
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
189 if (isempty (hax)) |
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
190 hax = gca (); |
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
191 endif |
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
192 plot (hax, x, y, fmt); |
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
193 axis (hax, limits); |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
194 if (isvector (y)) |
17159
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
195 legend (hax, nam); |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
196 else |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
197 for i = 1:columns (y) |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
198 nams{i} = sprintf ("%s(:,%i)", nam, i); |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
199 endfor |
17159
d74e2b5bdeb5
fplot.m: Accept an axis handle as first input.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
200 legend (hax, nams{:}); |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
201 endif |
6781 | 202 endif |
16338
8aeb5d5c3747
fplot.m: Overhaul code to use modern coding practices.
Rik <rik@octave.org>
parents:
14868
diff
changeset
|
203 |
5820 | 204 endfunction |
7245 | 205 |
206 | |
207 %!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
|
208 %! clf; |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
209 %! fplot (@cos, [0, 2*pi]); |
22302
1c4cd12987f5
Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents:
21831
diff
changeset
|
210 %! title ("fplot() single function"); |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
211 |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
212 %!demo |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
213 %! clf; |
22302
1c4cd12987f5
Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents:
21831
diff
changeset
|
214 %! fplot ("[cos(x), sin(x)]", [0, 2*pi]); |
1c4cd12987f5
Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents:
21831
diff
changeset
|
215 %! title ("fplot() multiple functions"); |
14237
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
216 |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
217 %!demo |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
218 %! clf; |
17026
be52288f827b
Tweak some plotting demos for messages and spelling.
Rik <rik@octave.org>
parents:
16951
diff
changeset
|
219 %! fh = @(x) sin (pi*x) ./ (pi*x); |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
220 %! fplot (fh, [-5, 5]); |
22302
1c4cd12987f5
Use Octave syntax in graphics demos.
Rik <rik@octave.org>
parents:
21831
diff
changeset
|
221 %! title ("fplot() sinc function (possible division by 0, near 0)"); |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
222 |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
223 %!test |
21831
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
224 %! ## Multi-valued function |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
225 %! [x, y] = fplot ("[cos(x), sin(x)]", [0, 2*pi]); |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
226 %! assert (columns (y) == 2); |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
227 %! assert (rows (x) == rows (y)); |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
228 %! assert (y, [cos(x), sin(x)], -2e-3); |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
229 |
21831
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
230 %!test |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
231 %! ## Function requiring transpose |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
232 %! fn = @(x) 2 * x(:).'; |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
233 %! [x, y] = fplot (fn, [-1, 1]); |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
234 %! assert (columns (y) == 1); |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
235 %! assert (rows (x) == rows (y)); |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
236 %! assert (y, 2*x); |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
237 |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
238 %!test |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
239 %! ## Constant value function |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
240 %! fn = @(x) 5; |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
241 %! [x, y] = fplot (fn, [-1, 1]); |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
242 %! assert (columns (y) == 1); |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
243 %! assert (rows (x) == rows (y)); |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
244 %! assert (y, repmat ([5], size (x))); |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
245 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
246 ## Test input validation |
16775
5ec3f4aea91c
fplot.m: Fix bug when FN is a constant function (bug #39287)
Rik <rik@octave.org>
parents:
16338
diff
changeset
|
247 %!error fplot (1) |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
248 %!error fplot (1,2,3,4,5,6) |
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
249 %!error <FN must be a function handle> fplot (1, [0 1]) |
16775
5ec3f4aea91c
fplot.m: Fix bug when FN is a constant function (bug #39287)
Rik <rik@octave.org>
parents:
16338
diff
changeset
|
250 %!error <LIMITS must be a real vector> fplot (@cos, [i, 2*i]) |
5ec3f4aea91c
fplot.m: Fix bug when FN is a constant function (bug #39287)
Rik <rik@octave.org>
parents:
16338
diff
changeset
|
251 %!error <LIMITS must be a real vector with 2 or 4> fplot (@cos, [1]) |
5ec3f4aea91c
fplot.m: Fix bug when FN is a constant function (bug #39287)
Rik <rik@octave.org>
parents:
16338
diff
changeset
|
252 %!error <LIMITS must be a real vector with 2 or 4> fplot (@cos, [1 2 3]) |
16950
b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
Rik <rik@octave.org>
parents:
16775
diff
changeset
|
253 %!error <bad input in position 3> fplot (@cos,[-1,1], {1}) |
21831
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
254 %!error <invalid function FN> |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
255 %! fn = @(x) [x;x]; |
1077f09a0cfd
fplot.m: Handle input functions which do not respect input data orientation (bug #48034).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
256 %! fplot (fn, [-1,1]); |