annotate scripts/strings/str2mat.m @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children 83a8781b529d
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) 1996, 1998, 1999, 2000, 2002, 2004, 2005, 2006, 2007
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## Kurt Hornik
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
3 ##
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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: 2311
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: 6046
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: 6046
diff changeset
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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: 2311
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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: 2311
diff changeset
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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: 6046
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: 6046
diff changeset
18 ## <http://www.gnu.org/licenses/>.
2273
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
19
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3174
diff changeset
20 ## -*- texinfo -*-
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3174
diff changeset
21 ## @deftypefn {Function File} {} str2mat (@var{s_1}, @dots{}, @var{s_n})
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3174
diff changeset
22 ## Return a matrix containing the strings @var{s_1}, @dots{}, @var{s_n} as
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3174
diff changeset
23 ## its rows. Each string is padded with blanks in order to form a valid
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3174
diff changeset
24 ## matrix.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
25 ##
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3174
diff changeset
26 ## This function is modelled after @sc{Matlab}. In Octave, you can create
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3174
diff changeset
27 ## a matrix of strings by @code{[@var{s_1}; @dots{}; @var{s_n}]} even if
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3174
diff changeset
28 ## the strings are not all the same length.
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3174
diff changeset
29 ## @end deftypefn
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
30
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
31 ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
2355
c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe]
jwe
parents: 2325
diff changeset
32 ## Adapted-By: jwe
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
33
3979
e0b7a493e5a8 [project @ 2002-07-10 17:45:34 by jwe]
jwe
parents: 3705
diff changeset
34 function retval = str2mat (varargin)
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
35
2273
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
36 if (nargin == 0)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5443
diff changeset
37 print_usage ();
2273
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
38 endif
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
39
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
40 nc = 0;
3168
1c267910655d [project @ 1998-04-19 01:22:38 by jwe]
jwe
parents: 2355
diff changeset
41 nr = 0;
2273
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
42
3168
1c267910655d [project @ 1998-04-19 01:22:38 by jwe]
jwe
parents: 2355
diff changeset
43 nr = zeros (nargin, 1);
1c267910655d [project @ 1998-04-19 01:22:38 by jwe]
jwe
parents: 2355
diff changeset
44 nc = zeros (nargin, 1);
2273
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
45 for k = 1 : nargin
3979
e0b7a493e5a8 [project @ 2002-07-10 17:45:34 by jwe]
jwe
parents: 3705
diff changeset
46 s = varargin{k};
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5428
diff changeset
47 if (! ischar (s))
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5428
diff changeset
48 s = char (s);
2273
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
49 endif
3705
7e90f4e9a4d5 [project @ 2000-07-22 01:57:25 by jwe]
jwe
parents: 3426
diff changeset
50 [nr(k), nc(k)] = size (s);
2273
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
51 endfor
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
52
3174
390d5e396682 [project @ 1998-05-04 16:36:17 by jwe]
jwe
parents: 3168
diff changeset
53 tmp = find (nr == 0);
390d5e396682 [project @ 1998-05-04 16:36:17 by jwe]
jwe
parents: 3168
diff changeset
54
390d5e396682 [project @ 1998-05-04 16:36:17 by jwe]
jwe
parents: 3168
diff changeset
55 if (! isempty (tmp))
390d5e396682 [project @ 1998-05-04 16:36:17 by jwe]
jwe
parents: 3168
diff changeset
56 nr(tmp) = 1;
390d5e396682 [project @ 1998-05-04 16:36:17 by jwe]
jwe
parents: 3168
diff changeset
57 endif
390d5e396682 [project @ 1998-05-04 16:36:17 by jwe]
jwe
parents: 3168
diff changeset
58
3168
1c267910655d [project @ 1998-04-19 01:22:38 by jwe]
jwe
parents: 2355
diff changeset
59 retval_nr = sum (nr);
1c267910655d [project @ 1998-04-19 01:22:38 by jwe]
jwe
parents: 2355
diff changeset
60 retval_nc = max (nc);
1c267910655d [project @ 1998-04-19 01:22:38 by jwe]
jwe
parents: 2355
diff changeset
61
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5428
diff changeset
62 retval = char (ones (retval_nr, retval_nc) * toascii (" "));
2273
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
63
3168
1c267910655d [project @ 1998-04-19 01:22:38 by jwe]
jwe
parents: 2355
diff changeset
64 row_offset = 0;
2273
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
65 for k = 1 : nargin
3979
e0b7a493e5a8 [project @ 2002-07-10 17:45:34 by jwe]
jwe
parents: 3705
diff changeset
66 s = varargin{k};
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5428
diff changeset
67 if (! ischar (s))
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5428
diff changeset
68 s = char (s);
3705
7e90f4e9a4d5 [project @ 2000-07-22 01:57:25 by jwe]
jwe
parents: 3426
diff changeset
69 endif
3168
1c267910655d [project @ 1998-04-19 01:22:38 by jwe]
jwe
parents: 2355
diff changeset
70 if (nc(k) > 0)
1c267910655d [project @ 1998-04-19 01:22:38 by jwe]
jwe
parents: 2355
diff changeset
71 retval ((row_offset + 1) : (row_offset + nr(k)), 1:nc(k)) = s;
2273
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
72 endif
3168
1c267910655d [project @ 1998-04-19 01:22:38 by jwe]
jwe
parents: 2355
diff changeset
73 row_offset = row_offset + nr(k);
2273
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
74 endfor
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
75
2273
5bc8dd06898d [project @ 1996-05-24 02:49:19 by jwe]
jwe
parents:
diff changeset
76 endfunction