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

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents a5c64dad5b93
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: 6753
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: 6753
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: 6753
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: 6753
diff changeset
17 ## <http://www.gnu.org/licenses/>.
2270
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
18
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
19 ## -*- texinfo -*-
6753
a5c64dad5b93 [project @ 2007-06-25 17:05:58 by jwe]
jwe
parents: 6046
diff changeset
20 ## @deftypefn {Function File} {} substr (@var{s}, @var{offset}, @var{len})
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
21 ## Return the substring of @var{s} which starts at character number
6753
a5c64dad5b93 [project @ 2007-06-25 17:05:58 by jwe]
jwe
parents: 6046
diff changeset
22 ## @var{offset} and is @var{len} characters long.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
23 ##
6753
a5c64dad5b93 [project @ 2007-06-25 17:05:58 by jwe]
jwe
parents: 6046
diff changeset
24 ## If @var{offset} is negative, extraction starts that far from the end of
a5c64dad5b93 [project @ 2007-06-25 17:05:58 by jwe]
jwe
parents: 6046
diff changeset
25 ## the string. If @var{len} is omitted, the substring extends to the end
2355
c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe]
jwe
parents: 2325
diff changeset
26 ## of S.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
27 ##
6753
a5c64dad5b93 [project @ 2007-06-25 17:05:58 by jwe]
jwe
parents: 6046
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: 2355
diff changeset
30 ## @example
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
31 ## substr ("This is a test string", 6, 9)
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
32 ## @result{} "is a test"
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
33 ## @end example
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
34 ##
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
35 ## This function is patterned after AWK. You can get the same result by
6753
a5c64dad5b93 [project @ 2007-06-25 17:05:58 by jwe]
jwe
parents: 6046
diff changeset
36 ## @code{@var{s} (@var{offset} : (@var{offset} + @var{len} - 1))}.
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
37 ## @end deftypefn
2270
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
38
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
39 ## 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
40 ## Adapted-By: jwe
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
41
2355
c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe]
jwe
parents: 2325
diff changeset
42 function t = substr (s, offset, len)
2270
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
43
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
44 if (nargin < 2 || nargin > 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5443
diff changeset
45 print_usage ();
2270
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
46 endif
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
47
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5428
diff changeset
48 if (ischar (s))
2270
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
49 nc = columns (s);
2355
c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe]
jwe
parents: 2325
diff changeset
50 if (abs (offset) > 0 && abs (offset) <= nc)
6753
a5c64dad5b93 [project @ 2007-06-25 17:05:58 by jwe]
jwe
parents: 6046
diff changeset
51 if (offset <= 0)
a5c64dad5b93 [project @ 2007-06-25 17:05:58 by jwe]
jwe
parents: 6046
diff changeset
52 offset += nc + 1;
2355
c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe]
jwe
parents: 2325
diff changeset
53 endif
2270
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
54 if (nargin == 2)
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
55 eos = nc;
2270
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
56 else
6753
a5c64dad5b93 [project @ 2007-06-25 17:05:58 by jwe]
jwe
parents: 6046
diff changeset
57 eos = offset + len - 1;
2270
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
58 endif
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
59 if (eos <= nc)
6753
a5c64dad5b93 [project @ 2007-06-25 17:05:58 by jwe]
jwe
parents: 6046
diff changeset
60 t = s (:, offset:eos);
2270
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
61 else
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
62 error ("substr: length = %d out of range", len);
2270
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
63 endif
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
64 else
2355
c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe]
jwe
parents: 2325
diff changeset
65 error ("substr: offset = %d out of range", offset);
2270
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
66 endif
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
67 else
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
68 error ("substr: expecting string argument");
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
69 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2314
diff changeset
70
2270
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe]
jwe
parents:
diff changeset
71 endfunction