Mercurial > octave-antonio
view 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 |
line wrap: on
line source
## Copyright (C) 1996-2015 Kurt Hornik ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} substr (@var{s}, @var{offset}) ## @deftypefnx {Function File} {} substr (@var{s}, @var{offset}, @var{len}) ## Return the substring of @var{s} which starts at character number ## @var{offset} and is @var{len} characters long. ## ## Position numbering for offsets begins with 1. If @var{offset} is negative, ## extraction starts that far from the end of the string. ## ## If @var{len} is omitted, the substring extends to the end of @var{s}. A ## negative value for @var{len} extracts to within @var{len} characters of ## the end of the string ## ## Examples: ## ## @example ## @group ## substr ("This is a test string", 6, 9) ## @result{} "is a test" ## substr ("This is a test string", -11) ## @result{} "test string" ## substr ("This is a test string", -11, -7) ## @result{} "test" ## @end group ## @end example ## ## This function is patterned after the equivalent function in Perl. ## @end deftypefn ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at> ## Adapted-By: jwe function t = substr (s, offset, len) if (nargin < 2 || nargin > 3) print_usage (); endif if (! ischar (s)) error ("substr: S must be a string or string array"); elseif (! isscalar (offset) || (nargin == 3 && ! isscalar (len))) error ("substr: OFFSET and LEN must be scalar integers"); endif offset = fix (offset); nc = columns (s); if (abs (offset) > nc || offset == 0) error ("substr: OFFSET = %d out of range", offset); endif if (offset <= 0) offset += nc + 1; endif if (nargin == 2) eos = nc; else len = fix (len); if (len < 0) eos = nc + len; else eos = offset + len - 1; endif endif if (eos > nc) error ("substr: length LEN = %d out of range", len); elseif (offset > eos && len != 0) error ("substr: No overlap with chosen values of OFFSET and LEN"); endif t = s(:, offset:eos); endfunction %!assert (substr ("This is a test string", 6, 9), "is a test") %!assert (substr ("This is a test string", -11), "test string") %!assert (substr ("This is a test string", -11, 4), "test") %!assert (substr ("This is a test string", -11, -7), "test") %!assert (substr ("This is a test string", 1, -7), "This is a test") %!assert (isempty (substr ("This is a test string", 1, 0))) ## Test input validation %!error substr () %!error substr ("foo", 2, 3, 4) %!error substr (ones (5, 1), 1, 1) %!error substr ("foo", ones (2,2)) %!error substr ("foo", 1, ones (2,2)) %!error substr ("foo", 0) %!error substr ("foo", 5) %!error substr ("foo", 1, 5) %!error substr ("foo", -1, 5) %!error substr ("foo", 2, -5)