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

annotate scripts/strings/cstrcat.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: 17744 diff changeset	1 ## Copyright (C) 1994-2015 John W. Eaton
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 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: 2303 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: 6145 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: 6145 diff changeset	8 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 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: 2303 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 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: 2303 diff changeset	13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 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: 6145 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: 6145 diff changeset	17 ## <http://www.gnu.org/licenses/>.
920 1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe] jwe parents: diff changeset	18
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3180 diff changeset	19 ## -- texinfo --
7540 3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m. Ben Abbott <bpabbott@mac.com> parents: 7504 diff changeset	20 ## @deftypefn {Function File} {} cstrcat (@var{s1}, @var{s2}, @dots{})
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	21 ## Return a string containing all the arguments concatenated horizontally
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	22 ## with trailing white space preserved.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	23 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	24 ## For example:
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	25 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	26 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	27 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	28 ## cstrcat ("ab ", "cd")
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	29 ## @result{} "ab cd"
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	30 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	31 ## @end example
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3361 diff changeset	32 ##
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3180 diff changeset	33 ## @example
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3180 diff changeset	34 ## @group
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3180 diff changeset	35 ## s = [ "ab"; "cde" ];
7540 3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m. Ben Abbott <bpabbott@mac.com> parents: 7504 diff changeset	36 ## cstrcat (s, s, s)
14402 cbcaf5602469 doc: Make spacing nicer for Strings chapter of manual. Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	37 ## @result{} "ab ab ab "
cbcaf5602469 doc: Make spacing nicer for Strings chapter of manual. Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	38 ## "cdecdecde"
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3180 diff changeset	39 ## @end group
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3180 diff changeset	40 ## @end example
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	41 ## @seealso{strcat, char, strvcat}
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3180 diff changeset	42 ## @end deftypefn
2697 6243c37ae2c5 [project @ 1997-02-18 17:51:21 by jwe] jwe parents: 2314 diff changeset	43
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	44 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	45
7540 3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m. Ben Abbott <bpabbott@mac.com> parents: 7504 diff changeset	46 function st = cstrcat (varargin)
920 1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe] jwe parents: diff changeset	47
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	48 if (nargin < 1)
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	49 print_usage ();
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	50 elseif (! iscellstr (varargin))
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	51 error ("cstrcat: expecting arguments to character strings");
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	52 endif
7504 ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	53
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	54 st = [varargin{:}];
920 1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe] jwe parents: diff changeset	55
7504 ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	56 endfunction
920 1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe] jwe parents: diff changeset	57
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	58
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	59 ## Test the dimensionality
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	60 ## 1d
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	61 %!assert (cstrcat ("ab ", "ab "), "ab ab ")
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	62 ## 2d
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	63 %!assert (cstrcat (["ab ";"cde"], ["ab ";"cde"]), ["ab ab ";"cdecde"])
7504 ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	64
13841 0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	65 %!assert (cstrcat ("foo", "bar"), "foobar")
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	66 %!assert (cstrcat (["a"; "bb"], ["foo"; "bar"]), ["a foo"; "bbbar"])
0a158dbdb04a Remove 3 unused warning ids Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	67
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	68 ## Test input validation
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	69 %!error cstrcat ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	70 %!error cstrcat (1, 2)
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	71

Mercurial > octave-antonio

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