Mercurial > hg > octave-nkf

annotate scripts/strings/strtrunc.m @ 20706:1339ad3c9faa stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix typo in str2func docstring. * ov-fcn-handle.cc (Ffunc2str): Fix typo where 'a' should be '@'.
author Rik <rik@octave.org>
date Tue, 22 Sep 2015 02:06:17 -0700
parents aa36fb998a4d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19898
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19790
diff changeset
1 ## Copyright (C) 2006-2015 William Poetra Yoga Hadisoeseno
5674
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
2 ##
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
4 ##
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
6 ## 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: 6046
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## your option) any later version.
5674
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
9 ##
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
14 ##
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
15 ## 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: 6046
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5674
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
18
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {} strtrunc (@var{s}, @var{n})
20374
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
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: 20038
diff changeset
22 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
diff changeset
23 ## If @var{s} is a character matrix, then the number of columns is adjusted.
20391
aa36fb998a4d maint: Remove unnecessary whitespace at end of lines.
Rik <rik@octave.org>
parents: 20374
diff changeset
24 ##
5674
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
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
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
27 ## @end deftypefn
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
28
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
29 function s = strtrunc (s, n)
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
30
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
31 if (nargin != 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5674
diff changeset
32 print_usage ();
5674
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
33 endif
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
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
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
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
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
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
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
55 endif
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
56
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe]
jwe
parents:
diff changeset
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);
19790
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
20038
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19898
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)
13301
29a4d3b4211e strtrunc.m: Add support and %!test for char arrays as cellstr elements
Rik <octave@nomad.inbox5.com>
parents: 13300
diff changeset
80