Mercurial > octave-antonio
view scripts/strings/ostrsplit.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) 2009-2015 Jaroslav Hajek ## ## 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} {[@var{cstr}] =} ostrsplit (@var{s}, @var{sep}) ## @deftypefnx {Function File} {[@var{cstr}] =} ostrsplit (@var{s}, @var{sep}, @var{strip_empty}) ## Split the string @var{s} using one or more separators @var{sep} and return ## a cell array of strings. ## ## Consecutive separators and separators at boundaries result in empty ## strings, unless @var{strip_empty} is true. The default value of ## @var{strip_empty} is false. ## ## 2-D character arrays are split at separators and at the original column ## boundaries. ## ## Example: ## ## @example ## @group ## ostrsplit ("a,b,c", ",") ## @result{} ## @{ ## [1,1] = a ## [1,2] = b ## [1,3] = c ## @} ## ## ostrsplit (["a,b" ; "cde"], ",") ## @result{} ## @{ ## [1,1] = a ## [1,2] = b ## [1,3] = cde ## @} ## @end group ## @end example ## @seealso{strsplit, strtok} ## @end deftypefn function cstr = ostrsplit (s, sep, strip_empty = false) if (nargin < 2 || nargin > 3) print_usage (); elseif (! ischar (s) || ! ischar (sep)) error ("ostrsplit: S and SEP must be string values"); elseif (! isscalar (strip_empty)) error ("ostrsplit: STRIP_EMPTY must be a scalar value"); endif if (isempty (s)) cstr = cell (size (s)); else if (rows (s) > 1) ## For 2-D arrays, add separator character at line boundaries ## and transform to single string s(:, end+1) = sep(1); s = reshape (s.', 1, numel (s)); s(end) = []; endif ## Split s according to delimiter if (isscalar (sep)) ## Single separator idx = find (s == sep); else ## Multiple separators idx = strchr (s, sep); endif ## Get substring lengths. if (isempty (idx)) strlens = length (s); else strlens = [idx(1)-1, diff(idx)-1, numel(s)-idx(end)]; endif ## Remove separators. s(idx) = []; if (strip_empty) ## Omit zero lengths. strlens = strlens(strlens != 0); endif ## Convert! cstr = mat2cell (s, 1, strlens); endif endfunction %!assert (ostrsplit ("road to hell", " "), {"road", "to", "hell"}) %!assert (ostrsplit ("road to^hell", " ^"), {"road", "to", "hell"}) %!assert (ostrsplit ("road to--hell", " -", true), {"road", "to", "hell"}) %!assert (ostrsplit (["a,bc";",de"], ","), {"a", "bc", char(ones(1,0)), "de "}) %!assert (ostrsplit (["a,bc";",de"], ",", true), {"a", "bc", "de "}) %!assert (ostrsplit (["a,bc";",de"], ", ", true), {"a", "bc", "de"}) ## Test input validation %!error ostrsplit () %!error ostrsplit ("abc") %!error ostrsplit ("abc", "b", true, 4) %!error <S and SEP must be string values> ostrsplit (123, "b") %!error <S and SEP must be string values> ostrsplit ("abc", 1) %!error <STRIP_EMPTY must be a scalar value> ostrsplit ("abc", "def", ones (3,3))