Mercurial > octave
view scripts/legacy/strmatch.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 | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2000-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{idx} =} strmatch (@var{s}, @var{A}) ## @deftypefnx {} {@var{idx} =} strmatch (@var{s}, @var{A}, "exact") ## ## This function is obsolete. @strong{Use an alternative} such as ## @code{strncmp} or @code{strcmp} instead. ## ## Return indices of entries of @var{A} which begin with the string @var{s}. ## ## The second argument @var{A} must be a string, character matrix, or a cell ## array of strings. ## ## If the third argument @qcode{"exact"} is not given, then @var{s} only ## needs to match @var{A} up to the length of @var{s}. Trailing spaces and ## nulls in @var{s} and @var{A} are ignored when matching. ## ## For example: ## ## @example ## @group ## strmatch ("apple", "apple juice") ## @result{} 1 ## ## strmatch ("apple", ["apple "; "apple juice"; "an apple"]) ## @result{} [1; 2] ## ## strmatch ("apple", ["apple "; "apple juice"; "an apple"], "exact") ## @result{} [1] ## @end group ## @end example ## ## @strong{Caution:} @code{strmatch} is obsolete (and can produce incorrect ## results in @sc{matlab} when used with cell arrays of strings. Use ## @code{strncmp} (normal case) or @code{strcmp} (@qcode{"exact"} case) in all ## new code. Other replacement possibilities, depending on application, ## include @code{regexp} or @code{validatestring}. ## @seealso{strncmp, strcmp, regexp, strfind, validatestring} ## @end deftypefn function idx = strmatch (s, A, exact) persistent warned = false; if (! warned) warned = true; warning ("Octave:legacy-function", "strmatch is obsolete; use strncmp or strcmp instead\n"); endif if (nargin < 2) print_usage (); endif if (iscellstr (s)) if (numel (s) > 1) error ("strmatch: a cell array S must contain only one string"); endif s = char (s); elseif (! ischar (s) || (! isempty (s) && ! isrow (s))) error ("strmatch: S must be a string"); elseif (! (ischar (A) || iscellstr (A))) error ("strmatch: A must be a string or cell array of strings"); endif ## Trim blanks and nulls from search string if (any (s != " " & s != "\0")) s = regexprep (s, "[ \\0]+$", ''); endif len = length (s); exact = nargin == 3 && ischar (exact) && strcmp (exact, "exact"); if (ischar (A)) [nr, nc] = size (A); if (len > nc) idx = []; else match = all (bsxfun (@eq, A(:,1:len), s), 2); if (exact) AA = A(:,len+1:nc); match &= all (AA == " " | AA == "\0", 2); endif idx = find (match); endif else if (len > 0) idx = find (strncmp (s, A, len)); else idx = find (strcmp (s, A)); endif if (exact) ## We can't just use strcmp, because we need to ignore spaces at end. B = regexprep (A(idx), "[ \\0]+$", ''); idx = idx(strcmp (s, B)); endif endif ## Return exactly sized and shaped values for Matlab compatibility. if (isempty (idx)) idx = []; # always return 0x0 empty matrix for non-match. else idx = idx(:); # always return column vector. endif endfunction ## First test is necessary to provoke 1-time legacy warning %!test %! warning ("off", "Octave:legacy-function", "local"); %! strmatch ("", ""); %!assert (strmatch ("a", {"aaa", "bab", "bbb"}), 1) %!assert (strmatch ("apple", "apple juice"), 1) %!assert (strmatch ("apple", ["apple pie"; "apple juice"; "an apple"]), [1; 2]) %!assert (strmatch ("apple", {"apple pie"; "apple juice"; "tomato"}), [1; 2]) %!assert (strmatch ("apple pie", "apple"), []) %!assert (strmatch ("a ", "a"), 1) %!assert (strmatch ("a", "a \0", "exact"), 1) %!assert (strmatch ("a b", {"a b", "a c", "c d"}), 1) %!assert (strmatch ("", {"", "foo", "bar", ""}), [1; 4]) %!assert (strmatch ('', {'', '% comment', 'var a = 5', ''}, "exact"), [1;4]) ## Weird Matlab corner cases %!test <*49601> %! assert (strmatch (" ", " "), 1); %! assert (strmatch (" ", " "), 1); %! assert (strmatch (" ", " "), []); %! assert (strmatch (" ", " "), 1); %!test <*54432> %! assert (strmatch ({"a"}, {"aaa", "bab", "bbb"}), 1); %! assert (isempty (strmatch ({}, {"aaa", "bab"}))); %!test <*59917> %! a = { "dfr", "tgh", "rere", "rere" }; %! b = strmatch ("rere", a, "exact"); %! assert (b, [3; 4]); ## Test input validation %!error <Invalid call to strmatch> strmatch () %!error <Invalid call to strmatch> strmatch ("a") %!error <called with too many inputs> strmatch ("a", "aaa", "exact", 1) %!error <S must contain only one string> strmatch ({"a", "b"}, "aaa") %!error <S must be a string> strmatch (1, "aaa") %!error <S must be a string> strmatch (char ("a", "bb"), "aaa") %!error <A must be a string> strmatch ("a", 1) %!error <A must be a string> strmatch ("a", {"hello", [1]})