Mercurial > hg > octave-nkf
diff scripts/strings/strmatch.m @ 8442:502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
author | Thorsten Meyer <thorsten.meyier@gmx.de> |
---|---|
date | Mon, 05 Jan 2009 08:11:03 +0100 |
parents | a1dbe9d80eee |
children | eb63fbe60fab |
line wrap: on
line diff
--- a/scripts/strings/strmatch.m +++ b/scripts/strings/strmatch.m @@ -23,7 +23,22 @@ ## The second argument @var{a} may be a string matrix or a cell array of ## strings. If the third argument @code{"exact"} is not given, then ## @var{s} only needs to match @var{a} up to the length of @var{s}. Nul -## characters match blanks. Results are returned as a column vector. +## characters match blanks. Results are returned as a column vector. +## For example: +## +## @example +## @group +## strmatch ("apple", "apple juice") +## @result{} 1 +## +## strmatch ("apple", ["apple pie"; "apple juice"; "an apple"]) +## @result{} [1; 2] +## +## strmatch ("apple", @{"apple pie"; "apple juice"; "tomato"@}) +## @result{} [1; 2] +## @end group +## @end example +## @seealso{strfind, findstr, strcmp, strncmp, strcmpi, strncmpi, find} ## @end deftypefn ## Author: Paul Kienzle, Alois Schloegl @@ -66,3 +81,13 @@ endif endfunction + +%!error <Invalid call to strmatch> strmatch(); +%!error <Invalid call to strmatch> strmatch("a", "aaa", "exact", 1); +%!assert (strmatch("a", {"aaa", "bab", "bbb"}), 1); +%!assert (strmatch ("apple", "apple juice"), 1); +%!assert (strmatch ("apple", ["apple pie"; "apple juice"; "an apple"]), +%! [1; 2]); +%!assert (strmatch ("apple", {"apple pie"; "apple juice"; "tomato"}), +%! [1; 2]); +%!assert (strmatch ("apple pie", "apple"), []);