octave-nkf: scripts/strings/index.m annotate

annotate scripts/strings/index.m @ 19867:9fc020886ae9

maint: Clean up m-files to follow Octave coding conventions. Try to trim long lines to < 80 chars. Use '##' for single line comments. Use '(...)' around tests for if/elseif/switch/while. Abut cell indexing operator '{' next to variable. Abut array indexing operator '(' next to variable. Use space between negation operator '!' and following expression. Use two newlines between endfunction and start of %!test or %!demo code. Remove unnecessary parens grouping between short-circuit operators. Remove stray extra spaces (typos) between variables and assignment operators. Remove stray extra spaces from ends of lines.

author	Rik <rik@octave.org>
date	Mon, 23 Feb 2015 14:54:39 -0800
parents	4197fc428c7d
children	df437a52bcaf

rev	line source
19731 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 1996-2015 Kurt Hornik
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	2 ##
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6901 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6901 diff changeset	8 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	10 ## 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	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	13 ## General Public License for more details.
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 ## 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	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6901 diff changeset	17 ## <http://www.gnu.org/licenses/>.
2271 707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe] jwe parents: diff changeset	18
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3240 diff changeset	19 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10409 diff changeset	20 ## @deftypefn {Function File} {} index (@var{s}, @var{t})
6139 4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	21 ## @deftypefnx {Function File} {} index (@var{s}, @var{t}, @var{direction})
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3240 diff changeset	22 ## Return the position of the first occurrence of the string @var{t} in the
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	23 ## string @var{s}, or 0 if no occurrence is found. @var{s} may also be a
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	24 ## string array or cell array of strings.
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	25 ##
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	26 ## For example:
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3361 diff changeset	27 ##
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3240 diff changeset	28 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	29 ## @group
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3240 diff changeset	30 ## index ("Teststring", "t")
14402 cbcaf5602469 doc: Make spacing nicer for Strings chapter of manual. Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	31 ## @result{} 4
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	32 ## @end group
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3240 diff changeset	33 ## @end example
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3361 diff changeset	34 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14402 diff changeset	35 ## 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	36 ## 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	37 ##
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	38 ## @seealso{find, rindex}
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3240 diff changeset	39 ## @end deftypefn
2271 707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe] jwe parents: diff changeset	40
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	41 ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
2355 c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe] jwe parents: 2325 diff changeset	42 ## Adapted-By: jwe
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	43 ## This is patterned after the AWK function of the same name.
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	44
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	45 function n = index (s, t, direction = "first")
2271 707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe] jwe parents: diff changeset	46
6139 4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	47 if (nargin < 2 \|\| nargin > 3)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5443 diff changeset	48 print_usage ();
2271 707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe] jwe parents: diff changeset	49 endif
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	50
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	51 if (ischar (s))
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	52 if (! isrow (s))
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	53 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	54 endif
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	55 elseif (! iscellstr (s))
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	56 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	57 endif
6139 4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	58
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	59 f = strfind (s, t);
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	60 if (isempty (f))
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	61 f = 0;
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	62 elseif (iscell (f))
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	63 f(cellfun ("isempty", f)) = {0};
2271 707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe] jwe parents: diff changeset	64 endif
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	65
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	66 direction = tolower (direction);
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	67
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	68 if (strcmp (direction, "first"))
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	69 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	70 n = cellfun ("min", f);
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	71 else
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	72 n = f(1);
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	73 endif
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	74 elseif (strcmp (direction, "last"))
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	75 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	76 n = cellfun ("max", f);
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	77 else
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	78 n = f(end);
10409 a87afd063e7d optimize index (call strfind) Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	79 endif
3911 8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe] jwe parents: 3759 diff changeset	80 else
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	81 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	82 endif
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	83
2271 707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe] jwe parents: diff changeset	84 endfunction
6139 4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	85
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	86
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	87 %!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	88 %!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	89
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	90 %!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	91 %!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	92 %!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	93 %!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	94 %!assert (index ("abc---", "abc+++"), 0)
6139 4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	95
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe] jwe parents: 6046 diff changeset	96 ## 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	97 %!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	98 %!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	99 %!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	100 %!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	101 %!assert (index ("abc---", "abc+++", "last"), 0)
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	102
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	103 %!test
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	104 %! 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	105 %! 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	106 %! 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	107 %! str = cellstr (str);
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	108 %! 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	109 %! 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	110
19867 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19731 diff changeset	111 ## Test input validation
13289 1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	112 %!error index ()
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	113 %!error index ("a")
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	114 %!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	115 %!error index (1, "bar")
1a6537dbce7b Expand index,rindex functions to accept char array inputs Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	116 %!error index ("foo", "bar", 3)
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	117

Mercurial > octave-nkf

annotate scripts/strings/index.m @ 19867:9fc020886ae9