annotate scripts/strings/strchr.m @ 11260:fd18ba11af57

Extra tests in strchr
author Kim Hansen <kim@ange.dk>
date Wed, 17 Nov 2010 04:16:59 -0500
parents be55736a0783
children 9c19b450b254
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 -*-
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})
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10408
diff changeset
23 ## Search for the string @var{str} for occurrences of characters from the set
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10408
diff changeset
24 ## @var{chars}.
8552
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
25 ## 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
26 ## identically as in @code{find}.
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
27 ##
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
28 ## This will be faster than using regexp in most cases.
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 ## @seealso{find}
8715
954b6f69f51d doc fixes
John W. Eaton <jwe@octave.org>
parents: 8552
diff changeset
31 ## @end deftypefn
8552
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
32
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
33 function varargout = strchr (str, chars, varargin)
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
34 if (nargin < 2 || ! ischar (str) || ! ischar (chars))
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
35 print_usage ();
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
36 endif
10408
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
37 if (isempty (chars))
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
38 mask = false (size (str));
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
39 elseif (length (chars) <= 6)
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
40 ## With a few characters, it pays off to build the mask incrementally.
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
41 ## We do it via a for loop to save memory.
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
42 mask = str == chars(1);
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
43 for i = 2:length (chars)
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
44 mask |= str == chars(i);
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
45 endfor
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
46 else
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
47 ## Index the str into a mask of valid values. This is slower than it could be
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
48 ## because of the +1 issue.
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
49 f = false (1, 256);
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
50 f(chars + 1) = true;
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
51 si = uint32 (str); # default goes via double - unnecessarily long.
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
52 ++si; # in-place
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
53 mask = reshape (f(si), size (str));
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
54 endif
8552
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
55 varargout = cell (1, nargout);
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
56 varargout{1} = [];
10408
a8869743d9fe optimize strchr
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
57 [varargout{:}] = find (mask, varargin{:});
8552
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
58 endfunction
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
59
11260
fd18ba11af57 Extra tests in strchr
Kim Hansen <kim@ange.dk>
parents: 10793
diff changeset
60 %!assert(strchr("Octave is the best software",""),zeros(1,0))
8552
3591fe09f3b1 add the strchr function
Jaroslav Hajek <highegg@gmail.com>
parents:
diff changeset
61 %!assert(strchr("Octave is the best software","best"),[3, 6, 9, 11, 13, 15, 16, 17, 18, 20, 23, 27])
11260
fd18ba11af57 Extra tests in strchr
Kim Hansen <kim@ange.dk>
parents: 10793
diff changeset
62 %!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])
fd18ba11af57 Extra tests in strchr
Kim Hansen <kim@ange.dk>
parents: 10793
diff changeset
63