Mercurial > octave

annotate scripts/strings/erase.m @ 26376:00f796120a6d stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Update copyright dates in all source files.
author John W. Eaton <jwe@octave.org>
date Wed, 02 Jan 2019 16:32:43 -0500
parents 6652d3823428
children ae1542fb58ba
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26376
00f796120a6d maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
1 ## Copyright (C) 2017-2019 Sahil Yadav
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
2 ##
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
3 ## This file is part of Octave.
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
4 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24473
diff changeset
5 ## Octave is free software: you can redistribute it and/or modify it
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24473
diff changeset
7 ## the Free Software Foundation, either version 3 of the License, or
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
8 ## (at your option) any later version.
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
9 ##
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
13 ## GNU General Public License for more details.
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
14 ##
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24473
diff changeset
17 ## <https://www.gnu.org/licenses/>.
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
18
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
19 ## -*- texinfo -*-
24985
d85b2485af9e doc: grammarcheck m-files ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24634
diff changeset
20 ## @deftypefn {} {@var{newstr} =} erase (@var{str}, @var{ptn})
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
21 ## Delete all occurrences of @var{ptn} within @var{str}.
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
22 ##
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
23 ## @var{str} and @var{ptn} can be ordinary strings, cell array of strings, or
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
24 ## character arrays.
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
25 ##
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
26 ## Examples
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
27 ##
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
28 ## @example
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
29 ## @group
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
30 ## ## string, single pattern
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
31 ## erase ("Hello World!", " World")
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
32 ## @result{} "Hello!"
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
33 ##
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
34 ## ## cellstr, single pattern
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
35 ## erase (@{"Hello", "World!"@}, "World")
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
36 ## @result{} @{"Hello", "!"@}
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
37 ##
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
38 ## ## string, multiple patterns
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
39 ## erase ("The Octave interpreter is fabulous", @{"interpreter ", "The "@})
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
40 ## @result{} "Octave is fabulous"
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
41 ##
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
42 ## ## cellstr, multiple patterns
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
43 ## erase (@{"The ", "Octave interpreter ", "is fabulous"@}, @{"interpreter ", "The "@})
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
44 ## @result{} @{"", "Octave ", "is fabulous"@}
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
45 ## @end group
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
46 ## @end example
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
47 ##
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
48 ## Programming Note: @code{erase} deletes the first instance of a pattern in a
24985
d85b2485af9e doc: grammarcheck m-files ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24634
diff changeset
49 ## string when there are overlapping occurrences. For example:
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
50 ##
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
51 ## @example
24985
d85b2485af9e doc: grammarcheck m-files ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24634
diff changeset
52 ## @group
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
53 ## erase ("abababa", "aba")
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
54 ## @result{} "b"
24985
d85b2485af9e doc: grammarcheck m-files ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24634
diff changeset
55 ## @end group
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
56 ## @end example
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
57 ##
24634
ab2321d4ba03 maint: strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
58 ## See @code{strrep} for processing overlaps.
ab2321d4ba03 maint: strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
59 ##
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
60 ## @seealso{strrep, regexprep}
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
61 ## @end deftypefn
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
62
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
63 ## Author: Sahil Yadav <yadavsahil5198@gmail.com>
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
64
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
65
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
66 function newstr = erase (str, ptn)
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
67
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
68 if (nargin != 2)
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
69 print_usage ();
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
70 endif
24634
ab2321d4ba03 maint: strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
71
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
72 ischarmatrix = false;
24634
ab2321d4ba03 maint: strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
73 if (ischar (str))
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
74 if (rows (str) > 1)
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
75 ## Convert to cell. Can't use cellstr which trims spaces.
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
76 str = mat2cell (str, ones (1, rows (str)));
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
77 ischarmatrix = true;
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
78 endif
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
79 elseif (! iscellstr (str))
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
80 error ("erase: STR must be a string or cell array of strings");
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
81 endif
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
82
24634
ab2321d4ba03 maint: strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
83 if (ischar (ptn))
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
84 if (rows (ptn) > 1)
24473
42d099b841aa erase.m: Add warning if a character array is used for PTN.
Rik <rik@octave.org>
parents: 24460
diff changeset
85 warning ("Octave:erase:chararray",
42d099b841aa erase.m: Add warning if a character array is used for PTN.
Rik <rik@octave.org>
parents: 24460
diff changeset
86 "erase: using character array for PTN is not recommended, consider cell array of strings instead");
24460
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
87 ## Convert to cell. Can't use cellstr which trims spaces.
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
88 ptn = mat2cell (ptn, ones (1, rows (ptn)));
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
89 endif
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
90 elseif (! iscellstr (ptn))
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
91 error ("erase: PTN must be a string or cell array of strings");
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
92 endif
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
93
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
94 nptn = ifelse (ischar (ptn), 1, numel (ptn));
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
95 if (nptn == 1)
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
96 newstr = strrep (str, ptn, "", "overlaps", false);
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
97 else
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
98 ptn = regexptranslate ("escape", ptn(:).');
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
99 ptn = strjoin (ptn, '|');
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
100 newstr = regexprep (str, ptn, "");
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
101 endif
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
102
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
103 if (ischarmatrix)
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
104 newstr = char (newstr);
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
105 endif
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
106
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
107 endfunction
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
108
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
109
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
110 %!assert (erase ("Hello World!", " World"), "Hello!")
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
111 %!assert (erase ({"Hello World!"}, " World"), {"Hello!"})
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
112 %!assert (erase (char ("Hello", "World!"), "World"), char ("Hello ", "!"))
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
113 %!assert (erase ({"Hello", "World!"}, "World"), {"Hello", "!"})
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
114 %!assert (erase ("Hello World!", {"o"; "World"; " "}), "Hell!")
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
115
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
116 ## Test overlaps
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
117 ## from https://savannah.gnu.org/bugs/?52647#comment5
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
118 %!assert (erase ('ababa', 'aba'), 'ba')
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
119 %!assert (erase ('abababa', 'aba'), 'b')
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
120 %!assert (erase ('ababababa', 'aba'), 'bba')
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
121 %!assert (erase ('ababababa', {'aba', 'bba'}), 'bba')
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
122 %!assert (erase ('ababababa ', {'aba', 'bba'}), 'bba ')
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
123 %!assert (erase ({' ababababa '}, {'aba', 'bba'}), {' bba '})
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
124 %!assert (erase (' ababa ', {'aba', 'baba'}), ' ba ')
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
125 %!assert (erase (' Hello World t ', {'t';'llo'}), ' He World ')
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
126 %!assert (erase ({' Hello World t '}, [ 'o ']), {' HellWorld t '})
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
127 %!assert (erase ( 'Hello World t ', {'ld '; 'o '}), 'HellWort ')
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
128 %!assert (erase ('aba', 'aba'), '')
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
129 %!assert (erase ({'aba'}, 'aba'), ({""}))
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
130 %!assert (erase ('', 'aba'), '')
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
131 %!assert (erase ({'abbabbabba'},{'abba'}), {'bb'})
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
132 %!assert (erase ({'ababababa';'abbabbabba'}, 'aba'), {'bba';'abbabbabba'})
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
133 %!assert (erase ({''}, {''}), {''})
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
134 %!assert (erase ({'pppppppp'}, 'p'), {''})
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
135 %!assert (erase ('Hello World t ', {'ld '; 'o '}), 'HellWort ')
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
136 %!assert (erase ({'Hello World t '}, {'ld '; 'o '}), {'HellWort '})
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
137
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
138 ## Test input validation
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
139 %!error erase ()
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
140 %!error erase ("a")
892f7f096ffb erase.m: New string function for deleting substrings with a string.
Sahil Yadav
parents:
diff changeset
141 %!error erase ("a", "b", "c")
24634
ab2321d4ba03 maint: strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
142 %!error <STR must be a string> erase ([1], "foo")
ab2321d4ba03 maint: strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
143 %!error <PTN must be a string> erase ("foo", [1])
24473
42d099b841aa erase.m: Add warning if a character array is used for PTN.
Rik <rik@octave.org>
parents: 24460
diff changeset
144 %!warning <using character array for PTN is not recommended>
42d099b841aa erase.m: Add warning if a character array is used for PTN.
Rik <rik@octave.org>
parents: 24460
diff changeset
145 %! erase ("a", ["a";"b"]);