Mercurial > octave
view scripts/legacy/vectorize.m @ 30893:e1788b1a315f
maint: Use "fcn" as preferred abbreviation for "function" in m-files.
* accumarray.m, accumdim.m, quadl.m, quadv.m, randi.m, structfun.m,
__is_function__.m, uigetfile.m, uimenu.m, uiputfile.m, doc_cache_create.m,
colorspace_conversion_input_check.m, imageIO.m, argnames.m, vectorize.m,
vectorize.m, normest1.m, inputname.m, nthargout.m, display_info_file.m,
decic.m, ode15i.m, ode15s.m, ode23.m, ode23s.m, ode45.m, odeset.m,
check_default_input.m, integrate_adaptive.m, ode_event_handler.m,
runge_kutta_23.m, runge_kutta_23s.m, runge_kutta_45_dorpri.m,
runge_kutta_interpolate.m, starting_stepsize.m, __all_opts__.m, fminbnd.m,
fminsearch.m, fminunc.m, fsolve.m, fzero.m, sqp.m, fplot.m, plotyy.m,
__bar__.m, __ezplot__.m, flat_entry.html, profexport.m, movfun.m, bicg.m,
bicgstab.m, cgs.m, eigs.m, gmres.m, pcg.m, __alltohandles__.m, __sprand__.m,
qmr.m, tfqmr.m, dump_demos.m:
Replace "func", "fun", "fn" in documentation and variable names with "fcn".
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 Apr 2022 18:14:56 -0700 |
parents | 5d3faba0342e |
children | b7edac56a810 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2020-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{vfcn} =} vectorize (@var{fcn}) ## Create a vectorized version of the anonymous function or expression ## @var{fcn} by replacing all occurrences of @code{*}, @code{/}, etc., ## with @code{.*}, @code{./}, etc. ## ## Note that the transformation is extremely simplistic. Use of this ## function is strongly discouraged. It may be removed from a future ## version of Octave. ## @end deftypefn ## The following function was translated directly from the original C++ ## version. Yes, it will be slow, but its use is strongly discouraged ## anyway, and most expressions will probably be short. It may also be ## buggy. Well, don't use this function! function vfcn = vectorize (fcn) persistent warned = false; if (! warned) warned = true; warning ("Octave:legacy-function", "vectorize is unreliable; its use is strongly discouraged\n"); endif if (nargin < 1) print_usage (); endif if (isa (fcn, "function_handle")) finfo = functions (fcn); if (! strcmp (finfo.type, "anonymous")) error ("vectorize: FCN must be a string or anonymous function handle"); endif expr = finfo.function; idx = index (expr, ")"); args = expr(1:idx); expr = expr(idx+1:end); new_expr = __vectorize__ (expr); vfcn = str2func ([args, new_expr]); elseif (ischar (fcn)) vfcn = __vectorize__ (fcn); else error ("vectorize: FCN must be a string or anonymous function handle"); endif endfunction %!assert (vectorize ("x.^2 + 1"), "x.^2 + 1") %!test %! fh = @(x) x.^2 + 1; %! finfo = functions (vectorize (fh)); %! assert (finfo.function, "@(x) x .^ 2 + 1"); %!assert (vectorize ("1e-3*y + 2e4*z"), "1e-3.*y + 2e4.*z") %!test %! fh = @(x, y, z) 1e-3*y + 2e4*z; %! finfo = functions (vectorize (fh)); %! assert (finfo.function, "@(x, y, z) 1e-3 .* y + 2e4 .* z"); %!assert (vectorize ("2^x^5"), "2.^x.^5") %!test %! fh = @(x) 2^x^5; %! finfo = functions (vectorize (fh)); %! assert (finfo.function, "@(x) 2 .^ x .^ 5"); ## Test input validation %!error <Invalid call> vectorize () %!error <FCN must be a string or anonymous function handle> vectorize (1)