Mercurial > octave-antonio

annotate scripts/strings/strcat.m @ 10037:e60f038146e1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
further simplify strcat
author Jaroslav Hajek <highegg@gmail.com>
date Mon, 28 Dec 2009 10:03:24 +0100
parents 691b4ba32425
children 693e22af08ae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2002, 2003,
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8664
diff changeset
2 ## 2005, 2006, 2007, 2008, 2009 John W. Eaton
10032
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
3 ## Copyright (C) 2009 Jaroslav Hajek
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
5 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
6 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
7 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
8 ## 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: 6145
diff changeset
9 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6145
diff changeset
10 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
11 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
12 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
13 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
15 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
16 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
17 ## 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: 6145
diff changeset
18 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6145
diff changeset
19 ## <http://www.gnu.org/licenses/>.
920
1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe]
jwe
parents:
diff changeset
20
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
21 ## -*- texinfo -*-
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
22 ## @deftypefn {Function File} {} strcat (@var{s1}, @var{s2}, @dots{})
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
23 ## Return a string containing all the arguments concatenated
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
24 ## horizontally. If the arguments are cells strings, @code{strcat}
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
25 ## returns a cell string with the individual cells concatenated.
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
26 ## For numerical input, each element is converted to the
9036
58604c45ca74 Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
27 ## corresponding ASCII character. Trailing white space is eliminated.
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
28 ## For example,
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
29 ##
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
30 ## @example
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
31 ## @group
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
32 ## s = [ "ab"; "cde" ];
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
33 ## strcat (s, s, s)
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
34 ## @result{} ans =
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
35 ## "ab ab ab "
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
36 ## "cdecdecde"
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
37 ## @end group
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
38 ## @end example
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
39 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
40 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
41 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
42 ## s = @{ "ab"; "cde" @};
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
43 ## strcat (s, s, s)
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
44 ## @result{} ans =
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
45 ## @{
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
46 ## [1,1] = ababab
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
47 ## [2,1] = cdecdecde
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
48 ## @}
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
49 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
50 ## @end example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
51 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8143
diff changeset
52 ## @seealso{cstrcat, char, strvcat}
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
53 ## @end deftypefn
2697
6243c37ae2c5 [project @ 1997-02-18 17:51:21 by jwe]
jwe
parents: 2314
diff changeset
54
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
55 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
56
6138
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe]
jwe
parents: 6046
diff changeset
57 function st = strcat (varargin)
920
1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe]
jwe
parents:
diff changeset
58
7504
ddcf233d765b detect cellstr args in strcat
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
59 if (nargin > 0)
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
60 if (nargin == 1)
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
61 st = varargin{1};
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
62 elseif (nargin > 1)
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
63 ## Convert to cells of strings
10032
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
64 uo = "UniformOutput";
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
65 reals = cellfun (@isreal, varargin);
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
66 if (any (reals))
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
67 varargin(reals) = cellfun (@char, varargin(reals), uo, false);
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
68 endif
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
69 chars = cellfun (@ischar, varargin);
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
70 allchar = all (chars);
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
71 varargin(chars) = cellfun (@cellstr, varargin(chars), uo, false);
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
72 if (! all (cellfun (@iscell, varargin)))
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
73 error ("strcat: inputs must be strings or cells of strings");
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
74 endif
7504
ddcf233d765b detect cellstr args in strcat
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
75
10037
e60f038146e1 further simplify strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 10032
diff changeset
76 ## We don't actually need to bring all cells to common size, because
e60f038146e1 further simplify strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 10032
diff changeset
77 ## cellfun can now expand scalar cells.
e60f038146e1 further simplify strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 10032
diff changeset
78 err = common_size (varargin{:});
10032
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
79
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
80 if (err)
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
81 error ("strcat: arguments must be the same size, or be scalars");
691b4ba32425 vectorize strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
82 endif
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
83
10037
e60f038146e1 further simplify strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 10032
diff changeset
84 ## Cellfun handles everything for us.
e60f038146e1 further simplify strcat
Jaroslav Hajek <highegg@gmail.com>
parents: 10032
diff changeset
85 st = cellfun (@horzcat, varargin{:}, uo, false);
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
86
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
87 if (allchar)
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
88 ## If all inputs were strings, return strings.
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
89 st = char (st);
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
90 endif
7504
ddcf233d765b detect cellstr args in strcat
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
91 endif
ddcf233d765b detect cellstr args in strcat
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
92 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5568
diff changeset
93 print_usage ();
920
1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe]
jwe
parents:
diff changeset
94 endif
1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe]
jwe
parents:
diff changeset
95
7504
ddcf233d765b detect cellstr args in strcat
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
96 endfunction
920
1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe]
jwe
parents:
diff changeset
97
6138
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe]
jwe
parents: 6046
diff changeset
98 ## test the dimensionality
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe]
jwe
parents: 6046
diff changeset
99 ## 1d
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
100 %!assert(strcat("ab ", "ab "), "abab")
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
101 %!assert(strcat({"ab "}, "ab "), {"ab ab"})
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
102 %!assert(strcat("ab ", {"ab "}), {"abab "})
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
103 %!assert(strcat({"ab "}, {"ab "}), {"ab ab "})
7813
12a68443191c [mq]: cellstr
Jaroslav Hajek <highegg@gmail.com>
parents: 7540
diff changeset
104 %!assert(strcat("", "ab"), "ab")
12a68443191c [mq]: cellstr
Jaroslav Hajek <highegg@gmail.com>
parents: 7540
diff changeset
105 %!assert(strcat("", {"ab"}, {""}), {"ab"})
6138
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe]
jwe
parents: 6046
diff changeset
106 ## 2d
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
107 %!assert(strcat(["ab ";"cde"], ["ab ";"cde"]), ["abab ";"cdecde"])
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
108
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
109 ## test for deblanking implied trailing spaces of character input
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
110 %!assert((strcmp (strcat ("foo", "bar"), "foobar") &&
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
111 %! strcmp (strcat (["a"; "bb"], ["foo"; "bar"]), ["afoo "; "bbbar"])));
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
112
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
113 ## test for mixing character and cell inputs
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
114 %!assert(all (strcmp (strcat ("a", {"bc", "de"}, "f"), {"abcf", "adef"})))
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
115
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
116 ## test for scalar strings with vector strings
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
117 %!assert(all (strcmp (strcat (["a"; "b"], "c"), ["ac"; "bc"])))
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
118
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
119 ## test with cells with strings of differing lengths
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
120 %!assert(all (strcmp (strcat ({"a", "bb"}, "ccc"), {"accc", "bbccc"})))
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
121 %!assert(all (strcmp (strcat ("a", {"bb", "ccc"}), {"abb", "accc"})))
7504
ddcf233d765b detect cellstr args in strcat
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
122
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
123 %!error strcat ();
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
124
8143
3a4694d67dbb strcat.m: Compatibility of non-char data
Ben Abbott <bpabbott@mac.com>
parents: 7813
diff changeset
125 %!assert (strcat (1, 2), strcat (char(1), char(2)))
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
126
8143
3a4694d67dbb strcat.m: Compatibility of non-char data
Ben Abbott <bpabbott@mac.com>
parents: 7813
diff changeset
127 %!assert (strcat ('', 2), strcat ([], char(2)))
3a4694d67dbb strcat.m: Compatibility of non-char data
Ben Abbott <bpabbott@mac.com>
parents: 7813
diff changeset
128