Mercurial > octave
annotate scripts/strings/strtrunc.m @ 26376:00f796120a6d stable
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 | b442ec6dda5c |
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) 2006-2019 William Poetra Yoga Hadisoeseno |
5674 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
5 ## Octave is free software: you can redistribute it and/or modify it |
5674 | 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:
23220
diff
changeset
|
7 ## the Free Software Foundation, either version 3 of the License, or |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
8 ## (at your option) any later version. |
5674 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
13 ## GNU General Public License for more details. |
5674 | 14 ## |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 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:
23220
diff
changeset
|
17 ## <https://www.gnu.org/licenses/>. |
5674 | 18 |
19 ## -*- texinfo -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20181
diff
changeset
|
20 ## @deftypefn {} {} strtrunc (@var{s}, @var{n}) |
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
21 ## Truncate the character string @var{s} to length @var{n}. |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
22 ## |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
23 ## If @var{s} is a character matrix, then the number of columns is adjusted. |
20181
aa36fb998a4d
maint: Remove unnecessary whitespace at end of lines.
Rik <rik@octave.org>
parents:
20164
diff
changeset
|
24 ## |
5674 | 25 ## If @var{s} is a cell array of strings, then the operation is performed |
13301
29a4d3b4211e
strtrunc.m: Add support and %!test for char arrays as cellstr elements
Rik <octave@nomad.inbox5.com>
parents:
13300
diff
changeset
|
26 ## on each cell element and the new cell array is returned. |
5674 | 27 ## @end deftypefn |
28 | |
29 function s = strtrunc (s, n) | |
30 | |
31 if (nargin != 2) | |
6046 | 32 print_usage (); |
5674 | 33 endif |
34 | |
13306
ad9b78544a22
strtrunc.m: Add input validation and tests for length argument n.
Rik <octave@nomad.inbox5.com>
parents:
13304
diff
changeset
|
35 n = fix (n); |
ad9b78544a22
strtrunc.m: Add input validation and tests for length argument n.
Rik <octave@nomad.inbox5.com>
parents:
13304
diff
changeset
|
36 if (! isscalar (n) || n < 0) |
ad9b78544a22
strtrunc.m: Add input validation and tests for length argument n.
Rik <octave@nomad.inbox5.com>
parents:
13304
diff
changeset
|
37 error ("strtrunc: length N must be a positive integer (N >= 0)"); |
ad9b78544a22
strtrunc.m: Add input validation and tests for length argument n.
Rik <octave@nomad.inbox5.com>
parents:
13304
diff
changeset
|
38 endif |
ad9b78544a22
strtrunc.m: Add input validation and tests for length argument n.
Rik <octave@nomad.inbox5.com>
parents:
13304
diff
changeset
|
39 |
5674 | 40 if (ischar (s)) |
13298
86d18a3cc911
strtrunc.m: Recode for 28X speedup for cellstr inputs
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
41 if (n < columns (s)) |
86d18a3cc911
strtrunc.m: Recode for 28X speedup for cellstr inputs
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
42 s = s(:, 1:n); |
86d18a3cc911
strtrunc.m: Recode for 28X speedup for cellstr inputs
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
43 endif |
86d18a3cc911
strtrunc.m: Recode for 28X speedup for cellstr inputs
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
44 elseif (iscellstr (s)) |
86d18a3cc911
strtrunc.m: Recode for 28X speedup for cellstr inputs
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
45 ## Convoluted approach converts cellstr to char matrix, trims the character |
86d18a3cc911
strtrunc.m: Recode for 28X speedup for cellstr inputs
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
46 ## matrix using indexing, and then converts back to cellstr with mat2cell. |
13301
29a4d3b4211e
strtrunc.m: Add support and %!test for char arrays as cellstr elements
Rik <octave@nomad.inbox5.com>
parents:
13300
diff
changeset
|
47 ## This approach is 24X faster than using cellfun with call to strtrunc |
13306
ad9b78544a22
strtrunc.m: Add input validation and tests for length argument n.
Rik <octave@nomad.inbox5.com>
parents:
13304
diff
changeset
|
48 idx = cellfun ("size", s, 2) > n; |
13301
29a4d3b4211e
strtrunc.m: Add support and %!test for char arrays as cellstr elements
Rik <octave@nomad.inbox5.com>
parents:
13300
diff
changeset
|
49 rows = cellfun ("size", s(idx), 1); |
13306
ad9b78544a22
strtrunc.m: Add input validation and tests for length argument n.
Rik <octave@nomad.inbox5.com>
parents:
13304
diff
changeset
|
50 if (! isempty (rows)) |
ad9b78544a22
strtrunc.m: Add input validation and tests for length argument n.
Rik <octave@nomad.inbox5.com>
parents:
13304
diff
changeset
|
51 s(idx) = mat2cell (char (s(idx))(:, 1:n), rows); |
ad9b78544a22
strtrunc.m: Add input validation and tests for length argument n.
Rik <octave@nomad.inbox5.com>
parents:
13304
diff
changeset
|
52 endif |
5674 | 53 else |
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
9036
diff
changeset
|
54 error ("strtrunc: S must be a character string or a cell array of strings"); |
5674 | 55 endif |
56 | |
57 endfunction | |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
58 |
13298
86d18a3cc911
strtrunc.m: Recode for 28X speedup for cellstr inputs
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
59 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
60 %!assert (strtrunc ("abcdefg", 4), "abcd") |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
61 %!assert (strtrunc ("abcdefg", 10), "abcdefg") |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
62 %!assert (strtrunc (char ("abcdef", "fedcba"), 3), ["abc"; "fed"]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
63 %!assert (strtrunc ({"abcdef", "fedcba"}, 3), {"abc", "fed"}) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
64 %!assert (strtrunc ({"", "1", "21", "321"}, 1), {"", "1", "2", "3"}) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
65 %!assert (strtrunc ({"1", "", "2"}, 1), {"1", "", "2"}) |
13301
29a4d3b4211e
strtrunc.m: Add support and %!test for char arrays as cellstr elements
Rik <octave@nomad.inbox5.com>
parents:
13300
diff
changeset
|
66 %!test |
29a4d3b4211e
strtrunc.m: Add support and %!test for char arrays as cellstr elements
Rik <octave@nomad.inbox5.com>
parents:
13300
diff
changeset
|
67 %! cstr = {"line1"; ["line2"; "line3"]; "line4"}; |
29a4d3b4211e
strtrunc.m: Add support and %!test for char arrays as cellstr elements
Rik <octave@nomad.inbox5.com>
parents:
13300
diff
changeset
|
68 %! y = strtrunc (cstr, 4); |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
69 %! assert (size (y), [3, 1]); |
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
70 %! assert (size (y{2}), [2, 4]); |
13301
29a4d3b4211e
strtrunc.m: Add support and %!test for char arrays as cellstr elements
Rik <octave@nomad.inbox5.com>
parents:
13300
diff
changeset
|
71 %! assert (y{2}, repmat ("line", 2, 1)); |
13298
86d18a3cc911
strtrunc.m: Recode for 28X speedup for cellstr inputs
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
72 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
73 ## Test input validation |
13298
86d18a3cc911
strtrunc.m: Recode for 28X speedup for cellstr inputs
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
74 %!error strtrunc () |
86d18a3cc911
strtrunc.m: Recode for 28X speedup for cellstr inputs
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
75 %!error strtrunc ("abcd") |
86d18a3cc911
strtrunc.m: Recode for 28X speedup for cellstr inputs
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
76 %!error strtrunc ("abcd", 4, 5) |
13306
ad9b78544a22
strtrunc.m: Add input validation and tests for length argument n.
Rik <octave@nomad.inbox5.com>
parents:
13304
diff
changeset
|
77 %!error <N must be a positive integer> strtrunc ("abcd", ones (2,2)) |
ad9b78544a22
strtrunc.m: Add input validation and tests for length argument n.
Rik <octave@nomad.inbox5.com>
parents:
13304
diff
changeset
|
78 %!error <N must be a positive integer> strtrunc ("abcd", -1) |
13298
86d18a3cc911
strtrunc.m: Recode for 28X speedup for cellstr inputs
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
79 %!error <S must be a character string or a cell array of strings> strtrunc (1, 1) |