octave: scripts/plot/draw/fplot.m annotate

annotate scripts/plot/draw/fplot.m @ 25803:23483673ba43

Use is_function_handle instead of isa (x, "function_handle"). * ov-fcn-handle.cc (Fis_function_handle): Add BIST test for an inline function. * gradient.m, isequal.m, isequaln.m, __makeinfo__.m, nthargout.m, decic.m, ode15i.m, ode15s.m, ode23.m, ode45.m, check_default_input.m, fplot.m, __ezplot__.m, __alltohandles__.m, qmr.m, spfun.m, args.tst: Use is_function_handle instead of isa (x, "function_handle").

author	Rik <rik@octave.org>
date	Wed, 15 Aug 2018 15:29:11 -0700
parents	6652d3823428
children	46757ec0bac2

rev	line source
25054 6652d3823428 maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	1 ## Copyright (C) 2005-2018 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 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24494 diff changeset	5 ## Octave is free software: you can redistribute it and/or modify it
5820 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
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24494 diff changeset	7 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	8 ## (at 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
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## GNU General Public License for more details.
5820 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
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24494 diff changeset	17 ## <https://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 --
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 bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	27 ## @var{fn} is a function handle, inline function, or string containing the
bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	28 ## name of the function to evaluate.
bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	29 ##
bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	30 ## The limits of the plot are of the form @w{@code{[@var{xlo}, @var{xhi}]}} or
bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	31 ## @w{@code{[@var{xlo}, @var{xhi}, @var{ylo}, @var{yhi}]}}.
bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	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 bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	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 bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	38 ##
bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	39 ## @var{n} is the minimum number of points to use. When @var{n} is specified,
24493 dc6404ab6947 doc: Small tweaks to fplot and surfnorm docstrings (bug #52761). Rik <rik@octave.org> parents: 24431 diff changeset	40 ## the maximum stepsize will be @code{(@var{xhi} - @var{xlo}) / @var{n}}. More
17479 bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	41 ## than @var{n} points may still be used in order to meet the relative
bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	42 ## tolerance requirement.
bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	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 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	55 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	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 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	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 ##
24415 3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	69 ## @code{fplot} performance is better when the function accepts and returns a
3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	70 ## vector argument. Consider this when writing user-defined functions and use
3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	71 ## element-by-element operators such as @code{.*}, @code{./}, etc. See the
3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	72 ## function @code{vectorize} for potentially converting inline or anonymous
3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	73 ## functions to vectorized versions.
20715 5b7643257978 Remove trailing whitespace at end of lines. Rik <rik@octave.org> parents: 20205 diff changeset	74 ##
20205 59911f536b07 fplot.m: Document requirement of accepting vector inputs (bug #42050). Rik <rik@octave.org> parents: 19833 diff changeset	75 ## @seealso{ezplot, plot, vectorize}
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	76 ## @end deftypefn
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	77
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	78 ## Author: Paul Kienzle <pkienzle@users.sf.net>
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	79
17159 d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	80 function [X, Y] = fplot (varargin)
d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	81
d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	82 [hax, varargin, nargin] = __plt_get_axis_arg__ ("fplot", varargin{:});
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	83
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	84 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	85 print_usage ();
6781 3058060c560f [project @ 2007-07-19 08:07:31 by dbateman] dbateman parents: 6699 diff changeset	86 endif
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman] dbateman parents: 6699 diff changeset	87
17159 d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	88 fn = varargin{1};
d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	89 limits = varargin{2};
d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	90 varargin = varargin(3:end);
d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	91
6699 3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe] jwe parents: 6220 diff changeset	92 if (strcmp (typeinfo (fn), "inline function"))
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe] jwe parents: 6220 diff changeset	93 fn = vectorize (fn);
3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe] jwe parents: 6220 diff changeset	94 nam = formula (fn);
25803 23483673ba43 Use is_function_handle instead of isa (x, "function_handle"). Rik <rik@octave.org> parents: 25054 diff changeset	95 elseif (is_function_handle (fn))
6699 3f4ccca05612 [project @ 2007-06-12 20:48:02 by jwe] jwe parents: 6220 diff changeset	96 nam = func2str (fn);
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	97 elseif (all (isalnum (fn)))
6781 3058060c560f [project @ 2007-07-19 08:07:31 by dbateman] dbateman parents: 6699 diff changeset	98 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	99 elseif (ischar (fn))
16338 8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices. Rik <rik@octave.org> parents: 14868 diff changeset	100 fn = vectorize (inline (fn));
8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices. Rik <rik@octave.org> parents: 14868 diff changeset	101 nam = formula (fn);
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	102 else
16338 8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices. Rik <rik@octave.org> parents: 14868 diff changeset	103 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	104 endif
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman] dbateman parents: 6699 diff changeset	105
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	106 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	107 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	108 endif
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	109
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	110 n = 5;
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	111 tol = 2e-3;
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	112 fmt = "";
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	113 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	114 arg = varargin{i};
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	115 if (ischar (arg))
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	116 fmt = arg;
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	117 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	118 if (arg == fix (arg))
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	119 n = arg;
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	120 else
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	121 tol = arg;
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	122 endif
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	123 else
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	124 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	125 endif
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	126 endfor
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	127
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 18629 diff changeset	128 if (n != 5)
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 18629 diff changeset	129 ## n was specified
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	130 x0 = linspace (limits(1), limits(2), n/2 + 1)';
6781 3058060c560f [project @ 2007-07-19 08:07:31 by dbateman] dbateman parents: 6699 diff changeset	131 y0 = feval (fn, x0);
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman] dbateman parents: 6699 diff changeset	132 x = linspace (limits(1), limits(2), n)';
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman] dbateman parents: 6699 diff changeset	133 y = feval (fn, x);
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman] dbateman parents: 6699 diff changeset	134 else
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	135 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	136 y0 = feval (fn, x0);
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	137 n = 8;
6781 3058060c560f [project @ 2007-07-19 08:07:31 by dbateman] dbateman parents: 6699 diff changeset	138 x = linspace (limits(1), limits(2), n)';
3058060c560f [project @ 2007-07-19 08:07:31 by dbateman] dbateman parents: 6699 diff changeset	139 y = feval (fn, x);
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	140 endif
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	141
24415 3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	142 if (isscalar (y0))
3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	143 warning ("fplot: FN is not a vectorized function which reduces performance");
3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	144 fn = @(x) arrayfun (fn, x); # Create a new fn that accepts vectors
3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	145 y0 = feval (fn, x0);
3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	146 y = feval (fn, x);
3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	147 endif
3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	148
21831 1077f09a0cfd fplot.m: Handle input functions which do not respect input data orientation (bug #48034). Rik <rik@octave.org> parents: 20852 diff changeset	149 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	150 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	151 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	152 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	153 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	154 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	155 else
1077f09a0cfd fplot.m: Handle input functions which do not respect input data orientation (bug #48034). Rik <rik@octave.org> parents: 20852 diff changeset	156 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	157 endif
7ef5b1b4e029 fplot.m: call axis after plot John W. Eaton <jwe@octave.org> parents: 7280 diff changeset	158
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	159 err0 = Inf;
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	160
21831 1077f09a0cfd fplot.m: Handle input functions which do not respect input data orientation (bug #48034). Rik <rik@octave.org> parents: 20852 diff changeset	161 ## 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	162 ## 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	163 ## used where they are needed and not spread evenly over the entire
17479 bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	164 ## x-range. Try any function with a discontinuity, such as
bdb237c7507c doc: Redo fplot docstring. Rik <rik@octave.org> parents: 17190 diff changeset	165 ## 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	166 ## 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	167
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	168 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	169 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	170 ## 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	171 ## since neither estimate is known a priori to be better than the other.
24415 3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	172 err = 0.5 * max (abs ((yi - y) ./ (yi + y + eps))(:));
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	173 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	174 ## 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	175 ## 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	176 break;
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	177 endif
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	178 x0 = x;
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	179 y0 = y;
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	180 err0 = err;
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	181 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	182 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	183 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	184 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	185 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	186 endif
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	187 endwhile
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	188
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	189 if (nargout == 2)
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	190 X = x;
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	191 Y = y;
6781 3058060c560f [project @ 2007-07-19 08:07:31 by dbateman] dbateman parents: 6699 diff changeset	192 else
17159 d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	193 if (isempty (hax))
d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	194 hax = gca ();
d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	195 endif
d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	196 plot (hax, x, y, fmt);
d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	197 axis (hax, limits);
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	198 if (isvector (y))
17159 d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	199 legend (hax, nam);
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	200 else
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	201 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	202 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	203 endfor
17159 d74e2b5bdeb5 fplot.m: Accept an axis handle as first input. Rik <rik@octave.org> parents: 17122 diff changeset	204 legend (hax, nams{:});
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	205 endif
6781 3058060c560f [project @ 2007-07-19 08:07:31 by dbateman] dbateman parents: 6699 diff changeset	206 endif
16338 8aeb5d5c3747 fplot.m: Overhaul code to use modern coding practices. Rik <rik@octave.org> parents: 14868 diff changeset	207
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	208 endfunction
7245 d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7017 diff changeset	209
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7017 diff changeset	210
d65670971cbc [project @ 2007-12-04 03:03:54 by jwe] jwe parents: 7017 diff changeset	211 %!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	212 %! clf;
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	213 %! fplot (@cos, [0, 2*pi]);
22302 1c4cd12987f5 Use Octave syntax in graphics demos. Rik <rik@octave.org> parents: 21831 diff changeset	214 %! 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	215
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	216 %!demo
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	217 %! clf;
22302 1c4cd12987f5 Use Octave syntax in graphics demos. Rik <rik@octave.org> parents: 21831 diff changeset	218 %! fplot ("[cos(x), sin(x)]", [0, 2*pi]);
1c4cd12987f5 Use Octave syntax in graphics demos. Rik <rik@octave.org> parents: 21831 diff changeset	219 %! 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	220
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	221 %!demo
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	222 %! clf;
17026 be52288f827b Tweak some plotting demos for messages and spelling. Rik <rik@octave.org> parents: 16951 diff changeset	223 %! fh = @(x) sin (pix) ./ (pix);
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	224 %! fplot (fh, [-5, 5]);
22302 1c4cd12987f5 Use Octave syntax in graphics demos. Rik <rik@octave.org> parents: 21831 diff changeset	225 %! 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	226
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	227 %!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	228 %! ## Multi-valued function
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	229 %! [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	230 %! assert (columns (y) == 2);
b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	231 %! 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	232 %! 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	233
21831 1077f09a0cfd fplot.m: Handle input functions which do not respect input data orientation (bug #48034). Rik <rik@octave.org> parents: 20852 diff changeset	234 %!test
1077f09a0cfd fplot.m: Handle input functions which do not respect input data orientation (bug #48034). Rik <rik@octave.org> parents: 20852 diff changeset	235 %! ## 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	236 %! 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	237 %! [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	238 %! 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	239 %! 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	240 %! 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	241
1077f09a0cfd fplot.m: Handle input functions which do not respect input data orientation (bug #48034). Rik <rik@octave.org> parents: 20852 diff changeset	242 %!test
1077f09a0cfd fplot.m: Handle input functions which do not respect input data orientation (bug #48034). Rik <rik@octave.org> parents: 20852 diff changeset	243 %! ## Constant value function
24415 3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	244 %! fn = @(x) 0;
21831 1077f09a0cfd fplot.m: Handle input functions which do not respect input data orientation (bug #48034). Rik <rik@octave.org> parents: 20852 diff changeset	245 %! [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	246 %! 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	247 %! assert (rows (x) == rows (y));
24415 3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	248 %! assert (y, repmat ([0], 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	249
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	250 ## 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	251 %!error fplot (1)
16950 b34202b24212 fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961). Rik <rik@octave.org> parents: 16775 diff changeset	252 %!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	253 %!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	254 %!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	255 %!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	256 %!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	257 %!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	258 %!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	259 %! 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	260 %! fplot (fn, [-1,1]);
24415 3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	261 %!warning <FN is not a vectorized function>
3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	262 %! fn = @(x) 0;
3cd47be4fcbe fplot.m: Fix handling of non-vectorized input functions (bug #52673). Rik <rik@octave.org> parents: 23220 diff changeset	263 %! [x,y] = fplot (fn, [-1,1]);