Mercurial > hg > octave-lyh

annotate scripts/strings/strtrim.m @ 12981:4ec4096f65d1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: State that required input is cellstr, not cell, for strtrim and deblank (Bug #34038) NEWS: Note incompatible changes to certain string functions since 3.4.2 deblank.m, strtrim.m: Document that cellstr, not cell, is required input.
author Rik <octave@nomad.inbox5.com>
date Sun, 21 Aug 2011 21:44:39 -0700
parents f89449967f0d
children a1049e4480f8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11191
diff changeset
1 ## Copyright (C) 1996-2011 Kurt Hornik
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
2 ##
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
4 ##
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
0d11a12643f1 [project @ 2007-10-08 18:23:44 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: 6975
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: 6975
diff changeset
8 ## your option) any later version.
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
9 ##
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
14 ##
0d11a12643f1 [project @ 2007-10-08 18:23:44 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: 6975
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: 6975
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
18
7346
40252ccfcb67 [project @ 2008-01-04 20:26:25 by jwe]
jwe
parents: 7017
diff changeset
19 ## -*- texinfo -*-
7666
693ac94c2854 Fixed minor bugs in help texts of [x|y|z]lim and strtrim
sh@sh-laptop
parents: 7346
diff changeset
20 ## @deftypefn {Function File} {} strtrim (@var{s})
12876
29cd5a828bb2 strtrim.m: Don't remove nuls (\0) from string.
Rik <octave@nomad.inbox5.com>
parents: 12874
diff changeset
21 ## Remove leading and trailing whitespace from @var{s}. If
7666
693ac94c2854 Fixed minor bugs in help texts of [x|y|z]lim and strtrim
sh@sh-laptop
parents: 7346
diff changeset
22 ## @var{s} is a matrix, @var{strtrim} trims each row to the length of
12981
4ec4096f65d1 doc: State that required input is cellstr, not cell, for strtrim and deblank (Bug #34038)
Rik <octave@nomad.inbox5.com>
parents: 12975
diff changeset
23 ## longest string. If @var{s} is a cell array of strings, operate recursively
4ec4096f65d1 doc: State that required input is cellstr, not cell, for strtrim and deblank (Bug #34038)
Rik <octave@nomad.inbox5.com>
parents: 12975
diff changeset
24 ## on each string element. For example:
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
25 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
26 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
27 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
28 ## strtrim (" abc ")
12981
4ec4096f65d1 doc: State that required input is cellstr, not cell, for strtrim and deblank (Bug #34038)
Rik <octave@nomad.inbox5.com>
parents: 12975
diff changeset
29 ## @result{} "abc"
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
30 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
31 ## strtrim ([" abc "; " def "])
12981
4ec4096f65d1 doc: State that required input is cellstr, not cell, for strtrim and deblank (Bug #34038)
Rik <octave@nomad.inbox5.com>
parents: 12975
diff changeset
32 ## @result{} ["abc " ; " def"]
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
33 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
34 ## @end example
12981
4ec4096f65d1 doc: State that required input is cellstr, not cell, for strtrim and deblank (Bug #34038)
Rik <octave@nomad.inbox5.com>
parents: 12975
diff changeset
35 ## @seealso{deblank}
7346
40252ccfcb67 [project @ 2008-01-04 20:26:25 by jwe]
jwe
parents: 7017
diff changeset
36 ## @end deftypefn
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
37
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
38 ## Author: John Swensen <jpswensen@jhu.edu>
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
39
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
40 ## This function was derived from deblank.
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
41
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
42 function s = strtrim (s)
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
43
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
44 if (nargin != 1)
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
45 print_usage ();
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
46 endif
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
47
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
48 if (ischar (s))
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
49
12876
29cd5a828bb2 strtrim.m: Don't remove nuls (\0) from string.
Rik <octave@nomad.inbox5.com>
parents: 12874
diff changeset
50 k = find (! isspace (s));
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
51 if (isempty (s) || isempty (k))
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
52 s = "";
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
53 else
12874
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
54 s = s(:, ceil (min (k) / rows (s)):ceil (max (k) / rows (s)));
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
55 endif
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
56
12975
f89449967f0d deblank.m, strtrim.m: Correctly validate cellstr inputs (Bug #34038)
Rik <octave@nomad.inbox5.com>
parents: 12925
diff changeset
57 elseif (iscellstr (s))
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
58
12876
29cd5a828bb2 strtrim.m: Don't remove nuls (\0) from string.
Rik <octave@nomad.inbox5.com>
parents: 12874
diff changeset
59 s = regexprep (s, "^[\\s\v]+|[\\s\v]+$", '');
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
60
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
61 else
12925
1c71c9bf0570 deblank.m: Speed up 15x on cellstr inputs. Restrict input to strings or cellstrings.
Rik <octave@nomad.inbox5.com>
parents: 12876
diff changeset
62 error ("strtrim: S argument must be a string or cellstring");
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
63 endif
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
64
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
65 endfunction
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
66
12874
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
67
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
68 %!assert (strtrim (" abc "), "abc");
12874
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
69 %!assert (strtrim (" "), "");
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
70 %!assert (strtrim ("abc"), "abc");
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
71 %!assert (strtrim ([" abc "; " def "]), ["abc "; " def"]);
12874
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
72 %!assert (strtrim ({" abc "; " def "}), {"abc"; "def"});
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
73
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
74 %!error <Invalid call to strtrim> strtrim ();
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
75 %!error <Invalid call to strtrim> strtrim ("abc", "def");
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
76 %!error <argument must be a string> strtrim (1);
12981
4ec4096f65d1 doc: State that required input is cellstr, not cell, for strtrim and deblank (Bug #34038)
Rik <octave@nomad.inbox5.com>
parents: 12975
diff changeset
77 %!error <argument must be a string> strtrim ({[]});
12874
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
78