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

annotate scripts/strings/cstrcat.m @ 8442:502e58a0d44f

Fix docstrings, add examples, references and tests to string functions

author	Thorsten Meyer <thorsten.meyier@gmx.de>
date	Mon, 05 Jan 2009 08:11:03 +0100
parents	3422f39573b1
children	eb63fbe60fab

rev	line source
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	1 ## Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2002, 2003,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	2 ## 2005, 2006, 2007 John W. Eaton
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	6 ## 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	7 ## 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	8 ## 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	9 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	11 ## 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	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	13 ## 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	14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2303 diff changeset	16 ## 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	17 ## 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	18 ## <http://www.gnu.org/licenses/>.
920 1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe] jwe parents: diff changeset	19
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3180 diff changeset	20 ## -- texinfo --
7540 3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m. Ben Abbott <bpabbott@mac.com> parents: 7504 diff changeset	21 ## @deftypefn {Function File} {} cstrcat (@var{s1}, @var{s2}, @dots{})
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	22 ## Return a string containing all the arguments concatenated
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	23 ## horizontally. Trailing white space is preserved. For example,
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	24 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	25 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	26 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	27 ## cstrcat ("ab ", "cd")
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	28 ## @result{} "ab cd"
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	29 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	30 ## @end example
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3361 diff changeset	31 ##
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3180 diff changeset	32 ## @example
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3180 diff changeset	33 ## @group
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3180 diff changeset	34 ## 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	35 ## cstrcat (s, s, s)
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	36 ## @result{} ans =
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7540 diff changeset	37 ## "ab ab ab "
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3180 diff changeset	38 ## "cdecdecde"
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
7504 ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	48 if (nargin > 0)
ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	49
ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	50 if (iscellstr (varargin))
ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	51 ## All arguments are character strings.
ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	52 unwind_protect
ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	53 tmp = warning ("query", "Octave:empty-list-elements");
ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	54 warning ("off", "Octave:empty-list-elements");
ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	55 st = [varargin{:}];
ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	56 unwind_protect_cleanup
ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	57 warning (tmp.state, "Octave:empty-list-elements");
ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	58 end_unwind_protect
ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	59 else
7540 3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m. Ben Abbott <bpabbott@mac.com> parents: 7504 diff changeset	60 error ("cstrcat: expecting arguments to character strings");
7504 ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	61 endif
ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	62 else
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5568 diff changeset	63 print_usage ();
920 1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe] jwe parents: diff changeset	64 endif
1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe] jwe parents: diff changeset	65
7504 ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	66 endfunction
920 1677bb6533fb [project @ 1994-11-14 16:37:05 by jwe] jwe parents: diff changeset	67
6138 c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6046 diff changeset	68 ## test the dimensionality
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6046 diff changeset	69 ## 1d
7540 3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m. Ben Abbott <bpabbott@mac.com> parents: 7504 diff changeset	70 %!assert(cstrcat("ab ", "ab "), "ab ab ")
6138 c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6046 diff changeset	71 ## 2d
7540 3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m. Ben Abbott <bpabbott@mac.com> parents: 7504 diff changeset	72 %!assert(cstrcat(["ab ";"cde"], ["ab ";"cde"]), ["ab ab ";"cdecde"])
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	73
7540 3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m. Ben Abbott <bpabbott@mac.com> parents: 7504 diff changeset	74 %!assert((strcmp (cstrcat ("foo", "bar"), "foobar")
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m. Ben Abbott <bpabbott@mac.com> parents: 7504 diff changeset	75 %! && strcmp (cstrcat (["a"; "bb"], ["foo"; "bar"]), ["a foo"; "bbbar"])));
7504 ddcf233d765b detect cellstr args in strcat John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	76
7540 3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m. Ben Abbott <bpabbott@mac.com> parents: 7504 diff changeset	77 %!error cstrcat ();
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	78
7540 3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m. Ben Abbott <bpabbott@mac.com> parents: 7504 diff changeset	79 %!error cstrcat (1, 2);
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	80

Mercurial > octave-antonio

annotate scripts/strings/cstrcat.m @ 8442:502e58a0d44f