Mercurial > octave-antonio
view scripts/strings/strtrim.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 | 4197fc428c7d |
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} {} strtrim (@var{s}) ## Remove leading and trailing whitespace from @var{s}. ## ## If @var{s} is a matrix, @var{strtrim} trims each row to the length of ## longest string. If @var{s} is a cell array of strings, operate recursively ## on each string element. ## ## For example: ## ## @example ## @group ## strtrim (" abc ") ## @result{} "abc" ## ## strtrim ([" abc "; " def "]) ## @result{} ["abc " ; " def"] ## @end group ## @end example ## @seealso{deblank} ## @end deftypefn ## Author: John Swensen <jpswensen@jhu.edu> ## This function was derived from deblank. function s = strtrim (s) if (nargin != 1) print_usage (); endif if (ischar (s)) k = find (! isspace (s)); if (isempty (s) || isempty (k)) s = ""; else s = s(:, ceil (min (k) / rows (s)):ceil (max (k) / rows (s))); endif elseif (iscell (s)) char_idx = cellfun ("isclass", s, "char"); cell_idx = cellfun ("isclass", s, "cell"); if (! all (char_idx | cell_idx)) error ("strtrim: S argument must be a string or cellstring"); endif ## Divide work load. Recursive cellfun strtrim call is slow ## and avoided where possible. s(char_idx) = regexprep (s(char_idx), "^[\\s\v]+|[\\s\v]+$", ''); s(cell_idx) = cellfun ("strtrim", s(cell_idx), "UniformOutput", false); else error ("strtrim: S argument must be a string or cellstring"); endif endfunction %!assert (strtrim (" abc "), "abc") %!assert (strtrim (" "), "") %!assert (strtrim ("abc"), "abc") %!assert (strtrim ([" abc "; " def "]), ["abc "; " def"]) %!assert (strtrim ({" abc "; " def "}), {"abc"; "def"}) %!assert (strtrim ({" abc ", {" def "}}), {"abc", {"def"}}) %!error <Invalid call to strtrim> strtrim () %!error <Invalid call to strtrim> strtrim ("abc", "def") %!error <argument must be a string> strtrim (1) %!error <argument must be a string> strtrim ({[]})