Mercurial > octave-antonio
view scripts/strings/strcat.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) 1994-2015 John W. Eaton ## Copyright (C) 2009 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} {} strcat (@var{s1}, @var{s2}, @dots{}) ## Return a string containing all the arguments concatenated ## horizontally. ## ## If the arguments are cell strings, @code{strcat} returns a cell string ## with the individual cells concatenated. For numerical input, each element ## is converted to the corresponding ASCII character. Trailing white space ## for any character string input is eliminated before the strings are ## concatenated. Note that cell string values do @strong{not} have ## whitespace trimmed. ## ## For example: ## ## @example ## @group ## strcat ("|", " leading space is preserved", "|") ## @result{} | leading space is preserved| ## @end group ## @end example ## ## @example ## @group ## strcat ("|", "trailing space is eliminated ", "|") ## @result{} |trailing space is eliminated| ## @end group ## @end example ## ## @example ## @group ## strcat ("homogeneous space |", " ", "| is also eliminated") ## @result{} homogeneous space || is also eliminated ## @end group ## @end example ## ## @example ## @group ## s = [ "ab"; "cde" ]; ## strcat (s, s, s) ## @result{} ## "ababab " ## "cdecdecde" ## @end group ## @end example ## ## @example ## @group ## s = @{ "ab"; "cd " @}; ## strcat (s, s, s) ## @result{} ## @{ ## [1,1] = ababab ## [2,1] = cd cd cd ## @} ## @end group ## @end example ## ## @seealso{cstrcat, char, strvcat} ## @end deftypefn ## Author: jwe function st = strcat (varargin) if (nargin == 0) print_usage (); endif if (nargin == 1) st = varargin{1}; else ## Convert to cells of strings uo = "uniformoutput"; reals = cellfun ("isreal", varargin); if (any (reals)) varargin(reals) = cellfun ("char", varargin(reals), uo, false); endif chars = cellfun ("isclass", varargin, "char"); allchar = all (chars); varargin(chars) = cellfun ("cellstr", varargin(chars), uo, false); if (! all (cellfun ("isclass", varargin, "cell"))) error ("strcat: inputs must be strings or cells of strings"); endif ## We don't actually need to bring all cells to common size, because ## cellfun can now expand scalar cells. err = common_size (varargin{:}); if (err) error ("strcat: arguments must be the same size, or be scalars"); endif ## Cellfun handles everything for us. st = cellfun ("horzcat", varargin{:}, uo, false); if (allchar) ## If all inputs were strings, return strings. st = char (st); endif endif endfunction ## test the dimensionality ## 1d %!assert (strcat ("ab ", "ab "), "abab") %!assert (strcat ({"ab "}, "ab "), {"ab ab"}) %!assert (strcat ("ab ", {"ab "}), {"abab "}) %!assert (strcat ({"ab "}, {"ab "}), {"ab ab "}) %!assert (strcat ("", "ab"), "ab") %!assert (strcat ("", {"ab"}, {""}), {"ab"}) ## 2d %!assert (strcat (["ab ";"cde"], ["ab ";"cde"]), ["abab ";"cdecde"]) ## test for deblanking implied trailing spaces of character input %!assert (strcat ("foo", "bar"), "foobar") %!assert (strcat (["a"; "bb"], ["foo"; "bar"]), ["afoo "; "bbbar"]) ## test for mixing character and cell inputs %!assert (strcat ("a", {"bc", "de"}, "f"), {"abcf", "adef"}) ## test for scalar strings with vector strings %!assert (strcat (["a"; "b"], "c"), ["ac"; "bc"]) ## test with cells with strings of differing lengths %!assert (all (strcmp (strcat ({"a", "bb"}, "ccc"), {"accc", "bbccc"}))) %!assert (all (strcmp (strcat ("a", {"bb", "ccc"}), {"abb", "accc"}))) %!assert (strcat (1, 2), strcat (char (1), char (2))) %!assert (strcat ("", 2), strcat ([], char (2))) %!error strcat ()