Mercurial > octave-antonio

annotate scripts/strings/rindex.m @ 20164:df437a52bcaf stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
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: 6139
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: 6139
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: 6139
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: 6139
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: 2355
diff changeset
19 ## -*- texinfo -*-
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
20 ## @deftypefn {Function File} {} rindex (@var{s}, @var{t})
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
21 ## Return the position of the last occurrence of the character string
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
22 ## @var{t} in the character string @var{s}, or 0 if no occurrence is
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
23 ## 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: 11523
diff changeset
26 ##
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
27 ## For example:
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
28 ##
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
29 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
30 ## @group
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
31 ## rindex ("Teststring", "t")
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
32 ## @result{} 6
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
33 ## @end group
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
34 ## @end example
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
35 ##
13289
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
36 ## The @code{rindex} function is equivalent to @code{index} with
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 14363
diff changeset
37 ## @var{direction} set to @qcode{"last"}.
13289
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
38 ##
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
39 ## @seealso{find, index}
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
40 ## @end deftypefn
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
41
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
42 ## 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
43 ## Adapted-By: jwe
13289
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
44 ## 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
45
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
46 function n = rindex (s, t)
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
47
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
48 if (nargin != 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5443
diff changeset
49 print_usage ();
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
50 endif
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
51
6139
4da9f63d5237 [project @ 2006-11-03 18:39:06 by jwe]
jwe
parents: 6046
diff changeset
52 n = index (s, t, "last");
3911
8389e78e67d4 [project @ 2002-04-28 02:15:38 by jwe]
jwe
parents: 3426
diff changeset
53
2271
707b9396ad2c [project @ 1996-05-24 02:22:01 by jwe]
jwe
parents:
diff changeset
54 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
55
13289
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
56
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
57 %!assert (rindex ("foobarbaz", "b"), 7)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
58 %!assert (rindex ("foobarbaz", "o"), 3)
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
59
13289
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
60 %!test
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
61 %! str = char ("Hello", "World", "Goodbye", "World");
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
62 %! assert (rindex (str, "o"), [5; 2; 3; 2]);
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
63 %! str = cellstr (str);
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
64 %! assert (rindex (str, "o"), [5; 2; 3; 2]);
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
65
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
66 ## Test input validation
13289
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
67 %!error rindex ()
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
68 %!error rindex ("foo")
1a6537dbce7b Expand index,rindex functions to accept char array inputs
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
69 %!error rindex ("foo", "bar", "last")
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
70