Mercurial > octave
view scripts/legacy/@inline/inline.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 796f54d4ddbf |
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{fobj} =} inline (@var{str}) ## @deftypefnx {} {@var{fobj} =} inline (@var{str}, @var{arg1}, @dots{}) ## @deftypefnx {} {@var{fobj} =} inline (@var{str}, @var{n}) ## ## This function is obsolete. Use anonymous functions ## (@pxref{Anonymous Functions}) instead. ## ## Create an inline function object from the character string @var{str}. ## ## If called with a single argument, the arguments of the generated ## function are extracted from the function itself. The generated ## function arguments will then be in alphabetical order. It should be ## noted that i and j are ignored as arguments due to the ambiguity ## between their use as a variable or their use as an built-in constant. ## All arguments followed by a parenthesis are considered to be ## functions. If no arguments are found, a function taking a single ## argument named @code{x} will be created. ## ## If the second and subsequent arguments are character strings, they ## are the names of the arguments of the function. ## ## If the second argument is an integer @var{n}, the arguments are ## @qcode{"x"}, @qcode{"P1"}, @dots{}, @qcode{"P@var{N}"}. ## ## @strong{Caution:} the use of @code{inline} is discouraged and it may ## be removed from a future version of Octave. The preferred way to ## create functions from strings is through the use of anonymous ## functions (@pxref{Anonymous Functions}) or @code{str2func}. ## @seealso{argnames, formula, vectorize, str2func} ## @end deftypefn function fobj = inline (expr, varargin) persistent warned = false; if (! warned) warned = true; warning ("Octave:legacy-function", "inline is obsolete; use anonymous functions instead\n"); endif if (nargin == 0) print_usage (); endif if (! ischar (expr)) error ("inline: EXPR must be a string"); endif if (nargin == 1) args = parse_expr_for_args (expr); elseif (nargin == 2) n = varargin{1}; if (isnumeric (n)) if (isscalar (n) && fix (n) == n) if (n > 0) args = strsplit (["x", sprintf(":P%d", 1:n)], ":"); else error ("inline: N must be a positive integer"); endif else error ("inline: N must be an integer"); endif else args = {"x"}; endif elseif (iscellstr (varargin)) args = varargin; else error ("inline: additional arguments must be strings"); endif p.expr = expr; p.args = args(:); p.numArgs = numel (args); tmp = [args; num2cell(1:numel(args))]; p.inputExpr = sprintf ("%s = INLINE_INPUTS_{%d}; ", tmp{:}); p.isEmpty = false; p.version = 1; fobj = __inline_ctor__ (p); endfunction ## The following function was translated directly from the original C++ ## version. Yes, it will be slow, but the use of inline functions is ## strongly discouraged anyway, and most expressions will probably be ## short. It may also be buggy. Well, don't use this object! Use ## function handles instead! function args = parse_expr_for_args (expr) persistent symbols_to_skip = {"i", "j", "NaN", "nan", "Inf", "inf", ... "NA", "pi", "e", "eps"}; is_arg = false; in_string = false; tmp_arg = ""; i = 1; expr_length = length (expr); args = {}; while (i <= expr_length) terminate_arg = false; c = expr(i++); if (in_string) if (c == "'" || c == '"') in_string = false; endif elseif (c == "'" || c == '"') in_string = true; if (is_arg) terminate_arg = true; endif elseif (! isalpha (c) && c != "_") if (! is_arg) continue; elseif (isdigit (c)) tmp_arg(end+1) = c; else ## Before we do anything remove trailing whitespaces. while (i <= expr_length && isspace (c)) c = expr(i++); endwhile ## Do we have a variable or a function? if (c != "(") terminate_arg = true; else tmp_arg = ""; is_arg = false; endif endif elseif (! is_arg) if (c == "e" || c == "E") ## Possible number in exponent form, not arg. if (isdigit (expr(i)) || expr(i) == "-" || expr(i) == "+") continue; endif endif is_arg = true; tmp_arg(end+1) = c; else tmp_arg(end+1) = c; endif if (terminate_arg || (i == expr_length+1 && is_arg)) have_arg = false; if (any (strcmp (tmp_arg, args))) have_arg = true; endif if (! (have_arg || any (strcmp (tmp_arg, symbols_to_skip)))) args{end+1} = tmp_arg; endif tmp_arg = ""; is_arg = false; endif endwhile ## Sort the arguments into ASCII order. args = sort (args); if (isempty (args)) args = {"x"}; endif endfunction