annotate scripts/strings/endsWith.m @ 28212:d052c11d47c6

Add new functions startsWith and endsWith (bug #57041). * scripts/strings: Add startsWith.m and endsWith.m. * scripts/strings/module.mk: Add references to new files. * doc/interpreter/strings.txi: Add docstrings to manual. * NEWS: Add to list of new functions. * scripts/help/__unimplemented__.m: Remove the two functions.
author Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
date Sun, 29 Mar 2020 22:15:32 +0200
parents
children 49384057fb03
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
28212
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
1 ########################################################################
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
2 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
3 ## Copyright (C) 2020 The Octave Project Developers
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
4 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
7 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
8 ## This file is part of Octave.
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
9 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
11 ## under the terms of the GNU General Public License as published by
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
13 ## (at your option) any later version.
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
14 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
18 ## GNU General Public License for more details.
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
19 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
20 ## You should have received a copy of the GNU General Public License
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
21 ## along with Octave; see the file COPYING. If not, see
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
22 ## <https://www.gnu.org/licenses/>.
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
23 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
24 ########################################################################
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
25
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
26 ## -*- texinfo -*-
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
27 ## @deftypefn {} {@var{retval} =} endsWith (@var{str}, @var{pattern})
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
28 ## @deftypefnx {} {@var{retval} =} endsWith (@var{str}, @var{pattern}, "IgnoreCase", @var{confirm_ignore})
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
29 ## Checks that a cell array of strings ends with a pattern
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
30 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
31 ## Return an array of logical values that indicates which strings in the cell
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
32 ## array of strings --- or the string --- @var{str} ends with a string in the
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
33 ## cell array of strings --- or the string --- @var{pattern}.
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
34 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
35 ## If the parameter @qcode{"IgnoreCase"} is set to true, then the function
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
36 ## will ignore the letter case of @var{str} and @var{pattern}. By default, the
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
37 ## comparison is case sensitive.
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
38 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
39 ## Examples:
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
40 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
41 ## @example
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
42 ## ## one string and one pattern while considering case
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
43 ## endsWith ("hello", "lo")
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
44 ## @result{} 1
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
45 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
46 ## ## one string and one pattern while ignoring case
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
47 ## endsWith ("hello", "LO", "IgnoreCase", true)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
48 ## @result{} 1
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
49 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
50 ## ## multiple strings and multiple patterns while considering case
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
51 ## endsWith (@{"tests.txt", "mydoc.odt", "myFunc.m", "results.pptx"@},
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
52 ## @{".docx", ".odt", ".txt"@})
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
53 ## @result{} 1 1 0 0
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
54 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
55 ## ## multiple strings and one pattern while considering case
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
56 ## endsWith (@{"TESTS.TXT", "mydoc.odt", "result.txt", "myFunc.m"@},
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
57 ## ".txt", "IgnoreCase", false)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
58 ## @result{} 0 0 1 0
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
59 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
60 ## ## multiple strings and one pattern while ignoring case
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
61 ## endsWith (@{"TESTS.TXT", "mydoc.odt", "result.txt", "myFunc.m"@},
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
62 ## ".txt", "IgnoreCase", true)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
63 ## @result{} 1 0 1 0
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
64 ## @end example
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
65 ##
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
66 ## @seealso{startsWith, strcmp, strcmpi}
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
67 ## @end deftypefn
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
68
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
69 function retval = endsWith (str, pattern, ignore_case, confirm_ignore)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
70 if (! (nargin == 2 || nargin == 4))
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
71 print_usage ();
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
72 endif
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
73
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
74 ## check input str and pattern
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
75 if (! (iscellstr (str) || ischar (str))
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
76 || ! (iscellstr (pattern) || ischar (pattern)))
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
77 error ("endsWith: arguments must be strings or cell arrays of strings");
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
78 else
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
79 str = cellstr (str);
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
80 pattern = cellstr (pattern);
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
81 endif
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
82
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
83 retval = zeros (size (str));
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
84
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
85 ## reverse str and pattern
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
86 for j = 1:numel (str)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
87 str{j} = flip (str{j});
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
88 endfor
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
89 for j = 1:numel (pattern)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
90 pattern{j} = flip (pattern{j});
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
91 endfor
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
92
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
93 if (nargin == 2)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
94 IgnoreFlag = false;
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
95 endif
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
96
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
97 if (nargin == 4)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
98 ## checks third input argument
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
99 if (! ischar (ignore_case) || isempty (ignore_case))
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
100 error ('endsWith: third input must be "IgnoreCase"');
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
101 endif
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
102
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
103 ## to be compatible with MATLAB
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
104 ## (MATLAB accepts the command with "I", "i", "Ig", "IG" ..etc )
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
105 if (! strncmpi (ignore_case, "IgnoreCase", length (ignore_case)))
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
106 error (['endsWith: invalid argument "%s"; ', ...
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
107 'third input must be "IgnoreCase"'], ignore_case);
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
108 endif
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
109
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
110 if (numel (confirm_ignore) != 1)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
111 error ("endsWith: 'IgnoreCase' value must be a logical scalar");
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
112 endif
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
113
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
114 ## to be compatible with MATLAB
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
115 ## (MATLAB accepts the command with true, 5, 1 ..etc )
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
116 try
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
117 IgnoreFlag = logical (confirm_ignore);
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
118 catch
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
119 error ("endsWith: 'IgnoreCase' value must be a logical scalar");
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
120 end_try_catch
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
121 endif
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
122
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
123 if (IgnoreFlag)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
124 for j = 1:numel (pattern)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
125 retval |= strncmpi (str, pattern{j}, length (pattern{j}));
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
126 endfor
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
127 else
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
128 for j = 1:numel (pattern)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
129 retval |= strncmp (str, pattern{j}, length (pattern{j}));
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
130 endfor
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
131 endif
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
132
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
133 endfunction
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
134
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
135
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
136 ## Test simple use with one string and one pattern
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
137 %!assert (endsWith ("hello", "lo"))
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
138 %!assert (! endsWith ("hello", "LO"))
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
139 %!assert (endsWith ("hello", "LO", "i", 5)) # check compatibility with MATLAB
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
140 %!assert (! endsWith ("hello", "no"))
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
141
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
142 ## Test multiple strings with a single pattern
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
143 %!test
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
144 %! str = {"myFile.odt", "results.ppt", "myCode.m"; ...
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
145 %! "data-analysis.ppt", "foundations.txt", "data.odt"};
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
146 %! pattern = ".odt";
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
147 %! correct_ans = [true, false, false; false, false, true];
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
148 %! assert (endsWith (str, pattern), correct_ans)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
149
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
150 ## Test multiple strings with multiple patterns
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
151 %!test
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
152 %! str = {"tests.txt", "mydoc.odt", "myFunc.m", "results.pptx"};
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
153 %! pattern = {".docx", ".odt", ".txt"};
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
154 %! correct_ans = [true, true, false, false];
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
155 %! assert (endsWith (str, pattern), correct_ans)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
156
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
157 ## Test IgnoreCase
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
158 %!test
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
159 %! str = {"TESTS.TXT", "mydoc.odt", "result.txt", "myFunc.m"};
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
160 %! pattern = ".txt";
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
161 %! correct_ans_with_ignore = [true, false, true, false];
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
162 %! correct_ans_without_ignore = [false, false, true, false];
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
163 %! assert (endsWith (str, pattern, "IgnoreCase", true), ...
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
164 %! correct_ans_with_ignore)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
165 %! assert (endsWith (str, pattern, "IgnoreCase", false), ...
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
166 %! correct_ans_without_ignore)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
167 %! assert (endsWith (str, pattern, "I", 500), ...
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
168 %! correct_ans_with_ignore) # check compatibility with MATLAB
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
169 %! assert (endsWith (str, pattern, "iG", 0), ...
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
170 %! correct_ans_without_ignore) # check compatibility with MATLAB
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
171
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
172 ## Test error detection
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
173 %!error <must be strings or cell arrays of strings> endsWith (152, "hi")
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
174
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
175 %!error <must be strings or cell arrays of strings> endsWith ("hello", 152)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
176
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
177 %!error <'IgnoreCase' value must be a logical scalar> ...
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
178 %! endsWith ("hello", "hi", "i", "true")
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
179
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
180 %!error <'IgnoreCase' value must be a logical scalar> ...
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
181 %! endsWith ("hello", "hi", "i", [1, 2])
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
182
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
183 %!error <invalid argument "ignire"; third input must be> ...
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
184 %! endsWith ("hello", "he", "ignire", 1)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
185
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
186 %!error <invalid argument "IgnoreCasefd"; third input must be> ...
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
187 %! endsWith ("hello", "he", "IgnoreCasefd", 1)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
188
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
189 %!error <third input must be "IgnoreCase"> endsWith ("hello", "he", "", 1)
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
190
d052c11d47c6 Add new functions startsWith and endsWith (bug #57041).
Abdallah Elshamy <abdallah.k.elshamy@gmail.com>
parents:
diff changeset
191 %!error <third input must be "IgnoreCase"> endsWith ("hello", "he", 5, 1)