annotate scripts/strings/split.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 34f96dd5441b
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
1 ## Copyright (C) 1996 Kurt Hornik
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
2 ##
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## 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
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.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## 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
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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/>.
2274
9750746d7da5 [project @ 1996-05-24 04:06:42 by jwe]
jwe
parents:
diff changeset
18
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3320
diff changeset
19 ## -*- texinfo -*-
5462
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
20 ## @deftypefn {Function File} {} split (@var{s}, @var{t}, @var{n})
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3320
diff changeset
21 ## Divides the string @var{s} into pieces separated by @var{t}, returning
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3320
diff changeset
22 ## the result in a string array (padded with blanks to form a valid
5462
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
23 ## matrix). If the optional input @var{n} is supplied, split @var{s}
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
24 ## into at most @var{n} different pieces.
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
25 ##
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
26 ## For example,
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
27 ##
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3320
diff changeset
28 ## @example
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3320
diff changeset
29 ## split ("Test string", "t")
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3320
diff changeset
30 ## @result{} "Tes "
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3320
diff changeset
31 ## " s "
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3320
diff changeset
32 ## "ring"
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3320
diff changeset
33 ## @end example
5462
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
34 ##
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
35 ## @example
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
36 ## split ("Test string", "t", 2)
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
37 ## @result{} "Tes "
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
38 ## " string"
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
39 ## @end example
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3320
diff changeset
40 ## @end deftypefn
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
41
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
42 ## 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
43 ## Adapted-By: jwe
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
44
5462
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
45 function m = split (s, t, n)
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
46
5462
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
47 if (nargin == 2 || nargin == 3)
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
48 if (nargin == 2)
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
49 n = length (s);
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
50 endif
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
51
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5428
diff changeset
52 if (ischar (s) && ischar (t))
5219
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
53
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
54 l_s = length (s);
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
55 l_t = length (t);
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
56
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
57 if (l_s == 0)
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
58 m = "";
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
59 return;
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
60 elseif (l_t == 0)
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
61 m = s';
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
62 return;
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
63 elseif (l_s < l_t)
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
64 error ("split: s must not be shorter than t");
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
65 endif
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
66
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
67 if (min (size (s)) != 1 || min (size (t)) != 1)
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
68 error("split: multi-line strings are not supported");
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
69 endif
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
70
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
71 ind = findstr (s, t, 0);
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
72 if (length (ind) == 0)
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
73 m = s;
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
74 return;
5462
74804828df1a [project @ 2005-09-22 18:36:22 by jwe]
jwe
parents: 5443
diff changeset
75 elseif (n - 1 < length(ind))
5473
3e4564ddd985 [project @ 2005-09-23 21:19:17 by jwe]
jwe
parents: 5462
diff changeset
76 ind = ind(1:n-1);
5219
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
77 endif
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
78 ind2 = [1, ind+l_t];
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
79 ind = [ind, l_s+1];
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
80
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
81 ind_diff = ind-ind2;
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
82
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
83 ## Create a matrix of the correct size that's filled with spaces.
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
84 m_rows = length (ind);
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
85 m_cols = max (ind_diff);
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
86 m = repmat (" ", m_rows, m_cols);
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
87
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
88 ## Copy the strings to the matrix.
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
89 for i = 1:length (ind)
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
90 tmp = ind2(i):(ind(i)-1);
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
91 m(i,1:length(tmp)) = s(tmp);
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
92 endfor
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
93 else
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
94 error ("split: both s and t must be strings");
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
95 endif
96661dd79291 [project @ 2005-03-16 20:44:39 by jwe]
jwe
parents: 5218
diff changeset
96 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5473
diff changeset
97 print_usage ();
2274
9750746d7da5 [project @ 1996-05-24 04:06:42 by jwe]
jwe
parents:
diff changeset
98 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
99
2274
9750746d7da5 [project @ 1996-05-24 04:06:42 by jwe]
jwe
parents:
diff changeset
100 endfunction