octave: scripts/strings/index.m annotate

annotate scripts/strings/index.m @ 33623:4517f929c59d bytecode-interpreter tip

maint: Merge default to bytecode-interpreter

author	Arun Giridhar <arungiridhar@gmail.com>
date	Fri, 24 May 2024 16:22:41 -0400
parents	2e484f9f1f18
children

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 32002 diff changeset	3 ## Copyright (C) 1996-2024 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	7 ##
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	8 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## (at your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	19 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	20 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6901 diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
2271 707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe] jwe parents: diff changeset	25
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3240 diff changeset	26 ## -- texinfo --
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	27 ## @deftypefn {} {@var{n} =} index (@var{s}, @var{t})
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	28 ## @deftypefnx {} {@var{n} =} index (@var{s}, @var{t}, @var{direction})
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3240 diff changeset	29 ## Return the position of the first occurrence of the string @var{t} in the
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	30 ## string @var{s}, or 0 if no occurrence is found.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	31 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	32 ## @var{s} may also be a string array or cell array of strings.
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	33 ##
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	34 ## For example:
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3361 diff changeset	35 ##
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3240 diff changeset	36 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	37 ## @group
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3240 diff changeset	38 ## index ("Teststring", "t")
14402 cbcaf5602469 doc: Make spacing nicer for Strings chapter of manual. Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	39 ## @result{} 4
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	40 ## @end group
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3240 diff changeset	41 ## @end example
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3361 diff changeset	42 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14402 diff changeset	43 ## If @var{direction} is @qcode{"first"}, return the first element found.
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14402 diff changeset	44 ## If @var{direction} is @qcode{"last"}, return the last element found.
6139 4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	45 ##
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	46 ## @seealso{find, rindex}
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3240 diff changeset	47 ## @end deftypefn
2271 707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe] jwe parents: diff changeset	48
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	49 function n = index (s, t, direction = "first")
2271 707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe] jwe parents: diff changeset	50
28789 28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27985 diff changeset	51 if (nargin < 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5443 diff changeset	52 print_usage ();
2271 707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe] jwe parents: diff changeset	53 endif
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	54
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	55 if (ischar (s))
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	56 if (! isrow (s))
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	57 s = cellstr (s); # Handle string arrays by conversion to cellstr
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	58 endif
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	59 elseif (! iscellstr (s))
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	60 error ("index: S must be a string, string array, or cellstr");
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	61 endif
6139 4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	62
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	63 f = strfind (s, t);
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	64 if (isempty (f))
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	65 f = 0;
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	66 elseif (iscell (f))
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	67 f(cellfun ("isempty", f)) = {0};
2271 707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe] jwe parents: diff changeset	68 endif
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	69
32002 939e5d952675 Use upper/lower in preference to toupper/tolower to match Matlab. Rik <rik@octave.org> parents: 31706 diff changeset	70 direction = lower (direction);
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	71
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	72 if (strcmp (direction, "first"))
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	73 if (iscell (f))
12931 cefd568ea073 Replace function handles with function names in cellfun calls for 15% speedup. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	74 n = cellfun ("min", f);
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	75 else
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	76 n = f(1);
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	77 endif
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	78 elseif (strcmp (direction, "last"))
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	79 if (iscell (f))
12931 cefd568ea073 Replace function handles with function names in cellfun calls for 15% speedup. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	80 n = cellfun ("max", f);
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	81 else
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	82 n = f(end);
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	83 endif
3911 8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe] jwe parents: 3759 diff changeset	84 else
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	85 error ('index: DIRECTION must be either "first" or "last"');
3911 8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe] jwe parents: 3759 diff changeset	86 endif
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	87
2271 707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe] jwe parents: diff changeset	88 endfunction
6139 4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	89
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	90
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	91 %!assert (index ("foobarbaz", "b"), 4)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	92 %!assert (index ("foobarbaz", "z"), 9)
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	93
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	94 %!assert (index ("astringbstringcstring", "s"), 2)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	95 %!assert (index ("astringbstringcstring", "st"), 2)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	96 %!assert (index ("astringbstringcstring", "str"), 2)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	97 %!assert (index ("astringbstringcstring", "string"), 2)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	98 %!assert (index ("abc---", "abc+++"), 0)
6139 4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	99
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	100 ## test everything out in reverse
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	101 %!assert (index ("astringbstringcstring", "s", "last"), 16)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	102 %!assert (index ("astringbstringcstring", "st", "last"), 16)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	103 %!assert (index ("astringbstringcstring", "str", "last"), 16)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	104 %!assert (index ("astringbstringcstring", "string", "last"), 16)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	105 %!assert (index ("abc---", "abc+++", "last"), 0)
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	106
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	107 %!test
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	108 %! str = char ("Hello", "World", "Goodbye", "World");
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	109 %! assert (index (str, "o"), [5; 2; 2; 2]);
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	110 %! assert (index (str, "o", "last"), [5; 2; 3; 2]);
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	111 %! str = cellstr (str);
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	112 %! assert (index (str, "o"), [5; 2; 2; 2]);
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	113 %! assert (index (str, "o", "last"), [5; 2; 3; 2]);
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	114
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	115 ## Test input validation
28886 d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 28789 diff changeset	116 %!error <Invalid call> index ()
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	117 %!error index ("a")
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	118 %!error index ("a", "b", "first", "d")
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	119 %!error index (1, "bar")
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	120 %!error index ("foo", "bar", 3)

Mercurial > octave

annotate scripts/strings/index.m @ 33623:4517f929c59d bytecode-interpreter tip