octave-antonio: scripts/strings/strchr.m annotate

annotate scripts/strings/strchr.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

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 2008-2015 Jaroslav Hajek
8552 3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	2 ##
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	3 ## This file is part of Octave.
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	4 ##
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	8 ## your option) any later version.
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	9 ##
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	13 ## General Public License for more details.
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	14 ##
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	18
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	19 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10408 diff changeset	20 ## @deftypefn {Function File} {@var{idx} =} strchr (@var{str}, @var{chars})
8552 3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	21 ## @deftypefnx {Function File} {@var{idx} =} strchr (@var{str}, @var{chars}, @var{n})
8830 fa981a053064 doc fixes John W. Eaton <jwe@octave.org> parents: 8715 diff changeset	22 ## @deftypefnx {Function File} {@var{idx} =} strchr (@var{str}, @var{chars}, @var{n}, @var{direction})
13320 9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	23 ## @deftypefnx {Function File} {[@var{i}, @var{j}] =} strchr (@dots{})
11261 9c19b450b254 strchr.m: style fixes John W. Eaton <jwe@octave.org> parents: 11260 diff changeset	24 ## Search for the string @var{str} for occurrences of characters from
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	25 ## the set @var{chars}.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	26 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	27 ## The return value(s), as well as the @var{n} and @var{direction} arguments
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	28 ## behave identically as in @code{find}.
8552 3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	29 ##
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	30 ## This will be faster than using regexp in most cases.
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	31 ##
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	32 ## @seealso{find}
8715 954b6f69f51d doc fixes John W. Eaton <jwe@octave.org> parents: 8552 diff changeset	33 ## @end deftypefn
8552 3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	34
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	35 function varargout = strchr (str, chars, varargin)
13320 9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	36
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	37 if (nargin < 2)
8552 3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	38 print_usage ();
13320 9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	39 elseif (! ischar (str))
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	40 error ("strchr: STR argument must be a string or string array");
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	41 elseif (! ischar (chars))
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	42 error ("strchr: CHARS argument must be a string");
8552 3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	43 endif
13320 9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	44
10408 a8869743d9fe optimize strchr Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	45 if (isempty (chars))
a8869743d9fe optimize strchr Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	46 mask = false (size (str));
13320 9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	47 elseif (length (chars) <= 4)
10408 a8869743d9fe optimize strchr Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	48 ## With a few characters, it pays off to build the mask incrementally.
a8869743d9fe optimize strchr Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	49 ## We do it via a for loop to save memory.
a8869743d9fe optimize strchr Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	50 mask = str == chars(1);
a8869743d9fe optimize strchr Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	51 for i = 2:length (chars)
a8869743d9fe optimize strchr Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	52 mask \|= str == chars(i);
a8869743d9fe optimize strchr Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	53 endfor
a8869743d9fe optimize strchr Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	54 else
13320 9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	55 ## Index the str into a mask of valid values.
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	56 ## This is slower than it could be because of the +1 issue.
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	57 f = false (256, 1);
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	58 f(uint8 (chars) + 1) = true;
11261 9c19b450b254 strchr.m: style fixes John W. Eaton <jwe@octave.org> parents: 11260 diff changeset	59 ## Default goes via double -- unnecessarily long.
9c19b450b254 strchr.m: style fixes John W. Eaton <jwe@octave.org> parents: 11260 diff changeset	60 si = uint32 (str);
13320 9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	61 ## in-place is faster than str+1
11261 9c19b450b254 strchr.m: style fixes John W. Eaton <jwe@octave.org> parents: 11260 diff changeset	62 ++si;
10408 a8869743d9fe optimize strchr Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	63 mask = reshape (f(si), size (str));
a8869743d9fe optimize strchr Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	64 endif
13320 9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	65
8552 3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	66 varargout = cell (1, nargout);
3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	67 varargout{1} = [];
10408 a8869743d9fe optimize strchr Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	68 [varargout{:}] = find (mask, varargin{:});
13320 9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	69
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	70 endfunction
8552 3591fe09f3b1 add the strchr function Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	71
13320 9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	72
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	73 %!assert (strchr ("Octave is the best software", ""), zeros (1,0))
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	74 %!assert (strchr ("Octave is the best software", "best"), [3, 6, 9, 11, 13, 15, 16, 17, 18, 20, 23, 27])
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	75 %!assert (strchr ("Octave is the best software", "software"), [3, 4, 6, 9, 11, 13, 16, 17, 18, 20, 21, 22, 23, 24, 25, 26, 27])
11260 fd18ba11af57 Extra tests in strchr Kim Hansen <kim@ange.dk> parents: 10793 diff changeset	76
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	77 ## Test input validation
13320 9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	78 %!error strchr ()
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	79 %!error strchr (1)
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	80 %!error <STR argument must be a string> strchr (1, "aeiou")
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	81 %!error <CHARS argument must be a string> strchr ("aeiou", 1)
9da8fbd17b92 strchr.m: Tune switching between algorithms. Add error messages to input validation. Rik <octave@nomad.inbox5.com> parents: 12474 diff changeset	82

Mercurial > octave-antonio

annotate scripts/strings/strchr.m @ 20164:df437a52bcaf stable