Mercurial > octave-antonio
view scripts/strings/index.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 9fc020886ae9 |
children |
line wrap: on
line source
## Copyright (C) 1996-2015 Kurt Hornik ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} index (@var{s}, @var{t}) ## @deftypefnx {Function File} {} index (@var{s}, @var{t}, @var{direction}) ## Return the position of the first occurrence of the string @var{t} in the ## string @var{s}, or 0 if no occurrence is found. ## ## @var{s} may also be a string array or cell array of strings. ## ## For example: ## ## @example ## @group ## index ("Teststring", "t") ## @result{} 4 ## @end group ## @end example ## ## If @var{direction} is @qcode{"first"}, return the first element found. ## If @var{direction} is @qcode{"last"}, return the last element found. ## ## @seealso{find, rindex} ## @end deftypefn ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at> ## Adapted-By: jwe ## This is patterned after the AWK function of the same name. function n = index (s, t, direction = "first") if (nargin < 2 || nargin > 3) print_usage (); endif if (ischar (s)) if (! isrow (s)) s = cellstr (s); # Handle string arrays by conversion to cellstr endif elseif (! iscellstr (s)) error ("index: S must be a string, string array, or cellstr"); endif f = strfind (s, t); if (isempty (f)) f = 0; elseif (iscell (f)) f(cellfun ("isempty", f)) = {0}; endif direction = tolower (direction); if (strcmp (direction, "first")) if (iscell (f)) n = cellfun ("min", f); else n = f(1); endif elseif (strcmp (direction, "last")) if (iscell (f)) n = cellfun ("max", f); else n = f(end); endif else error ('index: DIRECTION must be either "first" or "last"'); endif endfunction %!assert (index ("foobarbaz", "b"), 4) %!assert (index ("foobarbaz", "z"), 9) %!assert (index ("astringbstringcstring", "s"), 2) %!assert (index ("astringbstringcstring", "st"), 2) %!assert (index ("astringbstringcstring", "str"), 2) %!assert (index ("astringbstringcstring", "string"), 2) %!assert (index ("abc---", "abc+++"), 0) ## test everything out in reverse %!assert (index ("astringbstringcstring", "s", "last"), 16) %!assert (index ("astringbstringcstring", "st", "last"), 16) %!assert (index ("astringbstringcstring", "str", "last"), 16) %!assert (index ("astringbstringcstring", "string", "last"), 16) %!assert (index ("abc---", "abc+++", "last"), 0) %!test %! str = char ("Hello", "World", "Goodbye", "World"); %! assert (index (str, "o"), [5; 2; 2; 2]); %! assert (index (str, "o", "last"), [5; 2; 3; 2]); %! str = cellstr (str); %! assert (index (str, "o"), [5; 2; 2; 2]); %! assert (index (str, "o", "last"), [5; 2; 3; 2]); ## Test input validation %!error index () %!error index ("a") %!error index ("a", "b", "first", "d") %!error index (1, "bar") %!error index ("foo", "bar", 3)