annotate scripts/strings/strcat.m @ 8143:3a4694d67dbb

strcat.m: Compatibility of non-char data
author Ben Abbott <bpabbott@mac.com>
date Wed, 24 Sep 2008 14:42:04 -0400
parents 12a68443191c
children 502e58a0d44f
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,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## 2005, 2006, 2007 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
6 ## 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
7 ## 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
8 ## 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
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
11 ## 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
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
13 ## 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
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
16 ## 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
17 ## 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
18 ## <http://www.gnu.org/licenses/>.
920
1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe]
jwe
parents:
diff changeset
19
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
20 ## -*- texinfo -*-
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
21 ## @deftypefn {Function File} {} strcat (@var{s1}, @var{s2}, @dots{})
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
22 ## Return a string containing all the arguments concatenated. For example,
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
23 ##
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
24 ## @example
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
25 ## @group
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
26 ## s = [ "ab"; "cde" ];
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
27 ## strcat (s, s, s)
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
28 ## @result{} "ab ab ab "
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
29 ## "cdecdecde"
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
30 ## @end group
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
31 ## @end example
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3180
diff changeset
32 ## @end deftypefn
2697
6243c37ae2c5 [project @ 1997-02-18 17:51:21 by jwe]
jwe
parents: 2314
diff changeset
33
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
34 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
35
6138
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe]
jwe
parents: 6046
diff changeset
36 function st = strcat (varargin)
920
1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe]
jwe
parents:
diff changeset
37
7504
ddcf233d765b detect cellstr args in strcat
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
38 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
39 if (nargin == 1)
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
40 st = varargin{1};
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
41 elseif (nargin > 1)
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
42 ## Convert to cells of strings
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
43 numstrs(nargin) = 0;
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
44 dims{nargin} = [];
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
45 allchar = true;
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
46 for nv = 1:nargin
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
47 if (ischar (varargin{nv}))
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
48 varargin{nv} = cellstr (varargin{nv});
8143
3a4694d67dbb strcat.m: Compatibility of non-char data
Ben Abbott <bpabbott@mac.com>
parents: 7813
diff changeset
49 elseif (isreal (varargin{nv}))
3a4694d67dbb strcat.m: Compatibility of non-char data
Ben Abbott <bpabbott@mac.com>
parents: 7813
diff changeset
50 varargin{nv} = cellstr (char (varargin{nv}));
3a4694d67dbb strcat.m: Compatibility of non-char data
Ben Abbott <bpabbott@mac.com>
parents: 7813
diff changeset
51 elseif (isempty (varargin{nv}))
3a4694d67dbb strcat.m: Compatibility of non-char data
Ben Abbott <bpabbott@mac.com>
parents: 7813
diff changeset
52 varargin{nv} = cellstr ('');
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
53 elseif (iscell (varargin{nv}))
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
54 allchar = false;
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
55 else
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
56 error ("strcat: inputs must be strings or cells of strings.")
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
57 endif
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
58 dims{nv} = size (varargin{nv});
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
59 numstrs(nv) = numel (varargin{nv});
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
60 endfor
7504
ddcf233d765b detect cellstr args in strcat
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
61
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
62 ## Set all cells to a common size
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
63 n = find (numstrs == max (numstrs), 1);
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
64 maxstrs = numstrs (n);
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
65 dim = dims{n};
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
66 for nv = find (numstrs == 1)
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
67 str = varargin{nv}{1};
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
68 varargin{nv} = cell (dim);
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
69 varargin{nv}{:} = str;
7504
ddcf233d765b detect cellstr args in strcat
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
70 endfor
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
71
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
72 ## Concatenate the strings
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
73 st = varargin{1};
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
74 for ns = 1:maxstrs
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
75 for nv = 2:nargin
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
76 if (size_equal (st, varargin{nv}))
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
77 st{ns} = [st{ns}, varargin{nv}{ns}];
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
78 else
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
79 error ("strcat: arguments must be the same size, or be scalars.");
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
80 endif
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
81 endfor
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
82 endfor
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
83
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
84 if (allchar)
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
85 ## 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
86 st = char (st);
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
87 endif
7504
ddcf233d765b detect cellstr args in strcat
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
88 endif
ddcf233d765b detect cellstr args in strcat
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
89 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5568
diff changeset
90 print_usage ();
920
1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe]
jwe
parents:
diff changeset
91 endif
1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe]
jwe
parents:
diff changeset
92
7504
ddcf233d765b detect cellstr args in strcat
John W. Eaton <jwe@octave.org>
parents: 7411
diff changeset
93 endfunction
920
1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe]
jwe
parents:
diff changeset
94
6138
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe]
jwe
parents: 6046
diff changeset
95 ## test the dimensionality
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe]
jwe
parents: 6046
diff changeset
96 ## 1d
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
97 %!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
98 %!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
99 %!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
100 %!assert(strcat({"ab "}, {"ab "}), {"ab ab "})
7813
12a68443191c [mq]: cellstr
Jaroslav Hajek <highegg@gmail.com>
parents: 7540
diff changeset
101 %!assert(strcat("", "ab"), "ab")
12a68443191c [mq]: cellstr
Jaroslav Hajek <highegg@gmail.com>
parents: 7540
diff changeset
102 %!assert(strcat("", {"ab"}, {""}), {"ab"})
6138
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe]
jwe
parents: 6046
diff changeset
103 ## 2d
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
104 %!assert(strcat(["ab ";"cde"], ["ab ";"cde"]), ["abab ";"cdecde"])
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
105
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
106 ## 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
107 %!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
108 %! 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
109
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
110 ## 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
111 %!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
112
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
113 ## 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
114 %!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
115
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7504
diff changeset
116 ## 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
117 %!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
118 %!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
119
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
120 %!error strcat ();
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
121
8143
3a4694d67dbb strcat.m: Compatibility of non-char data
Ben Abbott <bpabbott@mac.com>
parents: 7813
diff changeset
122 %!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
123
8143
3a4694d67dbb strcat.m: Compatibility of non-char data
Ben Abbott <bpabbott@mac.com>
parents: 7813
diff changeset
124 %!assert (strcat ('', 2), strcat ([], char(2)))
3a4694d67dbb strcat.m: Compatibility of non-char data
Ben Abbott <bpabbott@mac.com>
parents: 7813
diff changeset
125