Mercurial > hg > octave-nkf

annotate scripts/strings/strchr.m @ 9051:1bf0ce0930be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammar check TexInfo in all .m files Cleanup documentation sources to follow a few consistent rules. Spellcheck was NOT done. (but will be in another changeset)
author Rik <rdrider0-list@yahoo.com>
date Fri, 27 Mar 2009 22:31:03 -0700
parents 58604c45ca74
children a8869743d9fe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8830
diff changeset
1 ## Copyright (C) 2008, 2009 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 -*-
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{idx} =} strchr (@var{str}, @var{chars})
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})
9036
58604c45ca74 Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
23 ## Search for the string @var{str} for occurrences of characters from the set @var{chars}.
8552
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
24 ## The return value, as well as the @var{n} and @var{direction} arguments behave
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
25 ## identically as in @code{find}.
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
26 ##
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
27 ## This will be faster than using regexp in most cases.
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
28 ##
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
29 ## @seealso{find}
8715
954b6f69f51d doc fixes
John W. Eaton <jwe@octave.org>
parents: 8552
diff changeset
30 ## @end deftypefn
8552
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 function varargout = strchr (str, chars, varargin)
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
33 if (nargin < 2 || ! ischar (str) || ! ischar (chars))
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
34 print_usage ();
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
35 endif
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
36 f = false (1, 256);
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
37 f(chars + 1) = true;
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
38 varargout = cell (1, nargout);
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
39 varargout{1} = [];
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
40 [varargout{:}] = find (reshape (f(str + 1), size (str)), varargin{:});
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
41 endfunction
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
42
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
43 %!assert(strchr("Octave is the best software","best"),[3, 6, 9, 11, 13, 15, 16, 17, 18, 20, 23, 27])