Mercurial > octave-antonio
annotate scripts/strings/index.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) 1996-2015 Kurt Hornik |
2325 | 2 ## |
2313 | 3 ## This file is part of Octave. |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
2313 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
2271 | 18 |
3361 | 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 | 21 ## @deftypefnx {Function File} {} index (@var{s}, @var{t}, @var{direction}) |
3361 | 22 ## 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
|
23 ## 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
|
24 ## |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
25 ## @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
|
26 ## |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
27 ## For example: |
3426 | 28 ## |
3361 | 29 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
30 ## @group |
3361 | 31 ## index ("Teststring", "t") |
14402
cbcaf5602469
doc: Make spacing nicer for Strings chapter of manual.
Rik <octave@nomad.inbox5.com>
parents:
14363
diff
changeset
|
32 ## @result{} 4 |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
33 ## @end group |
3361 | 34 ## @end example |
3426 | 35 ## |
17281
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{"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
|
37 ## If @var{direction} is @qcode{"last"}, return the last element found. |
6139 | 38 ## |
39 ## @seealso{find, rindex} | |
3361 | 40 ## @end deftypefn |
2271 | 41 |
5428 | 42 ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at> |
2355 | 43 ## Adapted-By: jwe |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
44 ## This is patterned after the AWK function of the same name. |
2314 | 45 |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
46 function n = index (s, t, direction = "first") |
2271 | 47 |
6139 | 48 if (nargin < 2 || nargin > 3) |
6046 | 49 print_usage (); |
2271 | 50 endif |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
51 |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
52 if (ischar (s)) |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
53 if (! isrow (s)) |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
54 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
|
55 endif |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
56 elseif (! iscellstr (s)) |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
57 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
|
58 endif |
6139 | 59 |
10409
a87afd063e7d
optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents:
9051
diff
changeset
|
60 f = strfind (s, t); |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
61 if (isempty (f)) |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
62 f = 0; |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
63 elseif (iscell (f)) |
10409
a87afd063e7d
optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents:
9051
diff
changeset
|
64 f(cellfun ("isempty", f)) = {0}; |
2271 | 65 endif |
2325 | 66 |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
67 direction = tolower (direction); |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
68 |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
69 if (strcmp (direction, "first")) |
10409
a87afd063e7d
optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents:
9051
diff
changeset
|
70 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
|
71 n = cellfun ("min", f); |
10409
a87afd063e7d
optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents:
9051
diff
changeset
|
72 else |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
73 n = f(1); |
10409
a87afd063e7d
optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents:
9051
diff
changeset
|
74 endif |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
75 elseif (strcmp (direction, "last")) |
10409
a87afd063e7d
optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents:
9051
diff
changeset
|
76 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
|
77 n = cellfun ("max", f); |
10409
a87afd063e7d
optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents:
9051
diff
changeset
|
78 else |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
79 n = f(end); |
10409
a87afd063e7d
optimize index (call strfind)
Jaroslav Hajek <highegg@gmail.com>
parents:
9051
diff
changeset
|
80 endif |
3911 | 81 else |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
82 error ('index: DIRECTION must be either "first" or "last"'); |
3911 | 83 endif |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
84 |
2271 | 85 endfunction |
6139 | 86 |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
87 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
88 %!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
|
89 %!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
|
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 ("astringbstringcstring", "s"), 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", "st"), 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", "str"), 2) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
94 %!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
|
95 %!assert (index ("abc---", "abc+++"), 0) |
6139 | 96 |
97 ## 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
|
98 %!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
|
99 %!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
|
100 %!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
|
101 %!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
|
102 %!assert (index ("abc---", "abc+++", "last"), 0) |
7411 | 103 |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
104 %!test |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
105 %! 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
|
106 %! 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
|
107 %! 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
|
108 %! str = cellstr (str); |
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]); |
7411 | 111 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
112 ## Test input validation |
13289
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
113 %!error index () |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
114 %!error index ("a") |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
115 %!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
|
116 %!error index (1, "bar") |
1a6537dbce7b
Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents:
12931
diff
changeset
|
117 %!error index ("foo", "bar", 3) |
7411 | 118 |