octave-nkf: scripts/deprecated/strmatch.m annotate

annotate scripts/deprecated/strmatch.m @ 19842:ebd27d8c63fd

update default branch to release as 4.0 Now that we plan to release default instead of the gui-release branch as 4.0, restore functions removed from the default branch. * java_new.m, default_save_options.m, gen_doc_cache.m, interp1q.m, isequalwithequalnans.m, java_convert_matrix.m, java_debug.m, java_invoke.m, java_unsigned_conversion.m, javafields.m, javamethods.m, re_read_readline_init_file.m, read_readline_init_file.m, saving_history.m: Restore deprecated functions. * scripts/deprecated/module.mk: Update. * NEWS: Update. * configure.ac (AC_INIT): Set version to 3.9.0+. (OCTAVE_MAJOR_VERSION): Now 3. (OCTAVE_MINOR_VERSION): Now 9.

author	John W. Eaton <jwe@octave.org>
date	Fri, 30 Jan 2015 11:51:45 -0500
parents	edf5d63c82e1
children	4197fc428c7d

rev	line source
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 17281 diff changeset	1 ## Copyright (C) 2000-2013 Paul Kienzle
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	2 ## Copyright (C) 2003 Alois Schloegl
10055 38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	3 ## Copyright (C) 2010 VZLU Prague
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	4 ##
5181 41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	5 ## This file is part of Octave.
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	6 ##
5181 41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	7 ## Octave is free software; you can redistribute it and/or modify it
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	8 ## 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: 6701 diff changeset	9 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6701 diff changeset	10 ## your option) any later version.
5181 41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	11 ##
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	12 ## Octave is distributed in the hope that it will be useful, but
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	13 ## WITHOUT ANY WARRANTY; without even the implied warranty of
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	15 ## General Public License for more details.
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	16 ##
6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	17 ## 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: 6701 diff changeset	18 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6701 diff changeset	19 ## <http://www.gnu.org/licenses/>.
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	20
5182 5b361aa47dff [project @ 2005-03-03 06:21:47 by jwe] jwe parents: 5181 diff changeset	21 ## -- texinfo --
12933 a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	22 ## @deftypefn {Function File} {} strmatch (@var{s}, @var{A})
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	23 ## @deftypefnx {Function File} {} strmatch (@var{s}, @var{A}, "exact")
19252 edf5d63c82e1 Deprecate strmatch function. Rik <rik@octave.org> parents: 17744 diff changeset	24 ##
19842 ebd27d8c63fd update default branch to release as 4.0 John W. Eaton <jwe@octave.org> parents: 19252 diff changeset	25 ## @code{strmatch} is deprecated and will be removed in Octave version 4.4.
19252 edf5d63c82e1 Deprecate strmatch function. Rik <rik@octave.org> parents: 17744 diff changeset	26 ## Use @code{strncmp} (normal case), or @code{strcmp} (@qcode{"exact"} case),
edf5d63c82e1 Deprecate strmatch function. Rik <rik@octave.org> parents: 17744 diff changeset	27 ## or @code{regexp} in all new code.
edf5d63c82e1 Deprecate strmatch function. Rik <rik@octave.org> parents: 17744 diff changeset	28 ##
12933 a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	29 ## Return indices of entries of @var{A} which begin with the string @var{s}.
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	30 ## The second argument @var{A} must be a string, character matrix, or a cell
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14363 diff changeset	31 ## array of strings. If the third argument @qcode{"exact"} is not given, then
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11354 diff changeset	32 ## @var{s} only needs to match @var{A} up to the length of @var{s}.
12937 1eebae7ac5d2 strmatch.m: Trim search pattern of spaces and nulls. Rik <octave@nomad.inbox5.com> parents: 12933 diff changeset	33 ## Trailing spaces and nulls in @var{s} and @var{A} are ignored when matching.
13141 e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 12973 diff changeset	34 ##
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	35 ## For example:
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	36 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	37 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	38 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	39 ## strmatch ("apple", "apple juice")
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	40 ## @result{} 1
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	41 ##
12933 a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	42 ## strmatch ("apple", ["apple "; "apple juice"; "an apple"])
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	43 ## @result{} [1; 2]
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	44 ##
12933 a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	45 ## strmatch ("apple", ["apple "; "apple juice"; "an apple"], "exact")
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	46 ## @result{} [1]
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	47 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	48 ## @end example
12933 a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	49 ##
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	50 ## @seealso{strfind, findstr, strcmp, strncmp, strcmpi, strncmpi, find}
5182 5b361aa47dff [project @ 2005-03-03 06:21:47 by jwe] jwe parents: 5181 diff changeset	51 ## @end deftypefn
5181 41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	52
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	53 ## Author: Paul Kienzle, Alois Schloegl
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	54 ## Adapted-by: jwe
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	55
19842 ebd27d8c63fd update default branch to release as 4.0 John W. Eaton <jwe@octave.org> parents: 19252 diff changeset	56 ## Deprecated in version 4.0
19252 edf5d63c82e1 Deprecate strmatch function. Rik <rik@octave.org> parents: 17744 diff changeset	57
5181 41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	58 function idx = strmatch (s, A, exact)
41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	59
19252 edf5d63c82e1 Deprecate strmatch function. Rik <rik@octave.org> parents: 17744 diff changeset	60 persistent warned = false;
edf5d63c82e1 Deprecate strmatch function. Rik <rik@octave.org> parents: 17744 diff changeset	61 if (! warned)
edf5d63c82e1 Deprecate strmatch function. Rik <rik@octave.org> parents: 17744 diff changeset	62 warned = true;
edf5d63c82e1 Deprecate strmatch function. Rik <rik@octave.org> parents: 17744 diff changeset	63 warning ("Octave:deprecated-function",
edf5d63c82e1 Deprecate strmatch function. Rik <rik@octave.org> parents: 17744 diff changeset	64 "strmatch is obsolete and will be removed from a future version of Octave, please use strncmp, strcmp, or regexp instead");
edf5d63c82e1 Deprecate strmatch function. Rik <rik@octave.org> parents: 17744 diff changeset	65 endif
edf5d63c82e1 Deprecate strmatch function. Rik <rik@octave.org> parents: 17744 diff changeset	66
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	67 if (nargin < 2 \|\| nargin > 3)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5307 diff changeset	68 print_usage ();
5178 6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	69 endif
6758c11b5b99 [project @ 2005-03-03 05:18:04 by jwe] jwe parents: diff changeset	70
12933 a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	71 if (! ischar (s) \|\| (! isempty (s) && ! isvector (s)))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 11469 diff changeset	72 error ("strmatch: S must be a string");
12933 a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	73 elseif (! (ischar (A) \|\| iscellstr (A)))
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	74 error ("strmatch: A must be a string or cell array of strings");
10055 38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	75 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	76
12937 1eebae7ac5d2 strmatch.m: Trim search pattern of spaces and nulls. Rik <octave@nomad.inbox5.com> parents: 12933 diff changeset	77 ## Trim blanks and nulls from search string
1eebae7ac5d2 strmatch.m: Trim search pattern of spaces and nulls. Rik <octave@nomad.inbox5.com> parents: 12933 diff changeset	78 s = regexprep (s, "[ \\0]+$", '');
10055 38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	79 len = length (s);
38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	80
38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	81 exact = nargin == 3 && ischar (exact) && strcmp (exact, "exact");
38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	82
12933 a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	83 if (ischar (A))
10055 38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	84 [nr, nc] = size (A);
38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	85 if (len > nc)
38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	86 idx = [];
38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	87 else
38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	88 match = all (bsxfun (@eq, A(:,1:len), s), 2);
38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	89 if (exact)
38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	90 AA = A(:,len+1:nc);
12933 a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	91 match &= all (AA == " " \| AA == "\0", 2);
10055 38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	92 endif
38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	93 idx = find (match);
5181 41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	94 endif
10055 38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	95 else
12933 a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	96 if (len > 0)
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	97 idx = find (strncmp (s, A, len));
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	98 else
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	99 idx = find (strcmp (s, A));
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	100 endif
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	101 if (exact)
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	102 ## We can't just use strcmp, because we need to ignore spaces at end.
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	103 B = regexprep (A(idx), "[ \\0]+$", '');
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	104 idx = idx(strcmp (s, B));
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	105 endif
5181 41cd70503c72 [project @ 2005-03-03 05:49:55 by jwe] jwe parents: 5178 diff changeset	106 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	107
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	108 endfunction
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	109
10055 38600f8cba83 optimize strmatch Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	110
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	111 %!assert (strmatch ("a", {"aaa", "bab", "bbb"}), 1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	112 %!assert (strmatch ("apple", "apple juice"), 1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	113 %!assert (strmatch ("apple", ["apple pie"; "apple juice"; "an apple"]), [1; 2])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	114 %!assert (strmatch ("apple", {"apple pie"; "apple juice"; "tomato"}), [1; 2])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	115 %!assert (strmatch ("apple pie", "apple"), [])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	116 %!assert (strmatch ("a ", "a"), 1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	117 %!assert (strmatch ("a", "a \0", "exact"), 1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	118 %!assert (strmatch ("a b", {"a b", "a c", "c d"}), 1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	119 %!assert (strmatch ("", {"", "foo", "bar", ""}), [1, 4])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	120 %!assert (strmatch ('', { '', '% comment', 'var a = 5', ''}, 'exact'), [1,4])
12933 a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	121
a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	122 %% Test input validation
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	123 %!error <Invalid call to strmatch> strmatch ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	124 %!error <Invalid call to strmatch> strmatch ("a")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	125 %!error <Invalid call to strmatch> strmatch ("a", "aaa", "exact", 1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	126 %!error <S must be a string> strmatch (1, "aaa")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	127 %!error <S must be a string> strmatch (char ("a", "bb"), "aaa")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	128 %!error <A must be a string> strmatch ("a", 1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14215 diff changeset	129 %!error <A must be a string> strmatch ("a", {"hello", [1]})
12933 a499469b05a4 strmatch.m: Revamp function for better speed and Matlab compatibility. Rik <octave@nomad.inbox5.com> parents: 12931 diff changeset	130

Mercurial > hg > octave-nkf

annotate scripts/deprecated/strmatch.m @ 19842:ebd27d8c63fd