octave-antonio: scripts/strings/substr.m annotate

annotate scripts/strings/substr.m @ 20164:df437a52bcaf stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Mon, 04 May 2015 14:22:02 -0700
parents	9fc020886ae9
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19593 diff changeset	1 ## Copyright (C) 1996-2015 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 --
13297 42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	20 ## @deftypefn {Function File} {} substr (@var{s}, @var{offset})
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	21 ## @deftypefnx {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	22 ## 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	23 ## @var{offset} and is @var{len} characters long.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3361 diff changeset	24 ##
13297 42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	25 ## Position numbering for offsets begins with 1. If @var{offset} is negative,
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	26 ## extraction starts that far from the end of the string.
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	27 ##
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	28 ## If @var{len} is omitted, the substring extends to the end of @var{s}. A
13297 42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	29 ## negative value for @var{len} extracts to within @var{len} characters of
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	30 ## the end of the string
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3361 diff changeset	31 ##
13297 42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	32 ## Examples:
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3361 diff changeset	33 ##
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 2355 diff changeset	34 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	35 ## @group
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 2355 diff changeset	36 ## substr ("This is a test string", 6, 9)
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 2355 diff changeset	37 ## @result{} "is a test"
13297 42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	38 ## substr ("This is a test string", -11)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	39 ## @result{} "test string"
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	40 ## substr ("This is a test string", -11, -7)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	41 ## @result{} "test"
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	42 ## @end group
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 2355 diff changeset	43 ## @end example
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3361 diff changeset	44 ##
13297 42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	45 ## This function is patterned after the equivalent function in Perl.
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 2355 diff changeset	46 ## @end deftypefn
2270 cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe] jwe parents: diff changeset	47
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	48 ## 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	49 ## Adapted-By: jwe
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	50
2355 c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe] jwe parents: 2325 diff changeset	51 function t = substr (s, offset, len)
2270 cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe] jwe parents: diff changeset	52
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe] jwe parents: diff changeset	53 if (nargin < 2 \|\| nargin > 3)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5443 diff changeset	54 print_usage ();
2270 cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe] jwe parents: diff changeset	55 endif
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe] jwe parents: diff changeset	56
13297 42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	57 if (! ischar (s))
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	58 error ("substr: S must be a string or string array");
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	59 elseif (! isscalar (offset) \|\| (nargin == 3 && ! isscalar (len)))
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	60 error ("substr: OFFSET and LEN must be scalar integers");
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	61 endif
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	62
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	63 offset = fix (offset);
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	64 nc = columns (s);
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	65 if (abs (offset) > nc \|\| offset == 0)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	66 error ("substr: OFFSET = %d out of range", offset);
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	67 endif
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	68
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	69 if (offset <= 0)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	70 offset += nc + 1;
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	71 endif
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	72
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	73 if (nargin == 2)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	74 eos = nc;
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	75 else
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	76 len = fix (len);
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	77 if (len < 0)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	78 eos = nc + len;
2270 cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe] jwe parents: diff changeset	79 else
13297 42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	80 eos = offset + len - 1;
2270 cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe] jwe parents: diff changeset	81 endif
cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe] jwe parents: diff changeset	82 endif
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	83
13297 42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	84 if (eos > nc)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	85 error ("substr: length LEN = %d out of range", len);
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	86 elseif (offset > eos && len != 0)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	87 error ("substr: No overlap with chosen values of OFFSET and LEN");
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	88 endif
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	89
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	90 t = s(:, offset:eos);
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	91
2270 cfcf8ff7d2dd [project @ 1996-05-24 02:10:11 by jwe] jwe parents: diff changeset	92 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	93
13297 42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	94
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	95 %!assert (substr ("This is a test string", 6, 9), "is a test")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	96 %!assert (substr ("This is a test string", -11), "test string")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	97 %!assert (substr ("This is a test string", -11, 4), "test")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	98 %!assert (substr ("This is a test string", -11, -7), "test")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	99 %!assert (substr ("This is a test string", 1, -7), "This is a test")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	100 %!assert (isempty (substr ("This is a test string", 1, 0)))
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	101
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	102 ## Test input validation
13297 42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	103 %!error substr ()
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	104 %!error substr ("foo", 2, 3, 4)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	105 %!error substr (ones (5, 1), 1, 1)
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	106 %!error substr ("foo", ones (2,2))
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	107 %!error substr ("foo", 1, ones (2,2))
13297 42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	108 %!error substr ("foo", 0)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	109 %!error substr ("foo", 5)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	110 %!error substr ("foo", 1, 5)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	111 %!error substr ("foo", -1, 5)
42d5ff896e85 substr.m: Expand function to accept negative values for length argument. Rik <octave@nomad.inbox5.com> parents: 12480 diff changeset	112 %!error substr ("foo", 2, -5)
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	113

Mercurial > octave-antonio

annotate scripts/strings/substr.m @ 20164:df437a52bcaf stable