annotate scripts/strings/strjoin.m @ 17306:09543e9c8f40

Use explicit form of end (endif, endfor, etc.) in core m-files. * scripts/general/interp1.m, scripts/image/rgb2ind.m, scripts/plot/__gnuplot_drawnow__.m, scripts/plot/private/__ezplot__.m, scripts/plot/private/__go_draw_axes__.m, scripts/special-matrix/gallery.m, scripts/strings/strjoin.m, scripts/testfun/assert.m, scripts/ui/questdlg.m: Use explicit form of end (endif, endfor, etc.) in core m-files.
author Rik <rik@octave.org>
date Wed, 21 Aug 2013 16:42:13 -0700
parents a4969508008e
children 088d014a7fe2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16768
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 16763
diff changeset
1 ## Copyright (C) 2007 Muthiah Annamalai
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 16763
diff changeset
2 ## Copyright (C) 2013 Ben Abbott
16400
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
3 ##
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
4 ## This file is part of Octave.
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
5 ##
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
7 ## under the terms of the GNU General Public License as published by
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
9 ## your option) any later version.
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
10 ##
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
14 ## General Public License for more details.
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
15 ##
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
16 ## You should have received a copy of the GNU General Public License
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
18 ## <http://www.gnu.org/licenses/>.
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
19
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
20 ## -*- texinfo -*-
16816
12005245b645 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 16815
diff changeset
21 ## @deftypefn {Function File} {@var{str} =} strjoin (@var{cstr})
16400
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
22 ## @deftypefnx {Function File} {@var{str} =} strjoin (@var{cstr}, @var{delimiter})
16816
12005245b645 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 16815
diff changeset
23 ## Join the elements of the cell-string array, @var{cstr}, into a single
16400
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
24 ## string.
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
25 ##
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
26 ## If no @var{delimiter} is specified, the elements of @var{cstr}
16826
a4969508008e doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents: 16817
diff changeset
27 ## separated by a space.
16400
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
28 ##
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
29 ## If @var{delimiter} is specified as a string, the cell-string array is
16816
12005245b645 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 16815
diff changeset
30 ## joined using the string. Escape sequences are supported.
16400
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
31 ##
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
32 ## If @var{delimiter} is a cell-string array whose length is one less
16826
a4969508008e doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents: 16817
diff changeset
33 ## than @var{cstr}, then the elements of @var{cstr} are joined by
16816
12005245b645 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 16815
diff changeset
34 ## interleaving the cell-string elements of @var{delimiter}. Escape
16763
70ea511edbc4 strjoin.m: delimiter can include escape sequences (matlab compatibility)
Stefan Mahr <dac922@gmx.de>
parents: 16761
diff changeset
35 ## sequences are not supported.
16400
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
36 ##
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
37 ## @example
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
38 ## @group
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
39 ## strjoin (@{'Octave','Scilab','Lush','Yorick'@}, '*')
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
40 ## @result{} 'Octave*Scilab*Lush*Yorick'
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
41 ## @end group
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
42 ## @end example
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
43 ## @seealso {strsplit}
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
44 ## @end deftypefn
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
45
16768
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 16763
diff changeset
46 ## Author: Muthiah Annamalai <muthiah.annamalai@uta.edu>
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 16763
diff changeset
47 ## Author: Ben Abbott <bpabbott@mac.com>
e2de3c8882be copyright notice fixes
John W. Eaton <jwe@octave.org>
parents: 16763
diff changeset
48
16400
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
49 function rval = strjoin (cstr, delimiter)
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
50
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
51 if (nargin == 1)
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
52 delimiter = " ";
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
53 elseif (nargin < 1 || nargin > 2)
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
54 print_usage ();
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
55 elseif (! (iscellstr (cstr) && (ischar (delimiter) || iscellstr (delimiter))))
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
56 print_usage ();
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
57 endif
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
58
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
59 if (numel (cstr) == 1)
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
60 rval = cstr{1};
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
61 return
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
62 endif
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
63
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
64 if (ischar (delimiter))
16763
70ea511edbc4 strjoin.m: delimiter can include escape sequences (matlab compatibility)
Stefan Mahr <dac922@gmx.de>
parents: 16761
diff changeset
65 delimiter = do_string_escapes (delimiter);
16400
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
66 delimiter = {delimiter};
17306
09543e9c8f40 Use explicit form of end (endif, endfor, etc.) in core m-files.
Rik <rik@octave.org>
parents: 16826
diff changeset
67 endif
16400
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
68
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
69 num = numel (cstr);
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
70 if (numel (delimiter) == 1 && num > 1)
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
71 delimiter = repmat (delimiter, 1, num);
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
72 delimiter(end) = {""};
16815
7a97ff5ef42e strjoin() should return an empty [0x0] string for an empty input.
Ben Abbott <bpabbott@mac.com>
parents: 16768
diff changeset
73 elseif (num > 0 && numel (delimiter) != num - 1)
16400
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
74 error ("strjoin:cellstring_delimiter_mismatch",
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
75 "strjoin: the number of delimiters does not match the number of strings")
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
76 else
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
77 delimiter(end+1) = {""};
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
78 endif
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
79
16815
7a97ff5ef42e strjoin() should return an empty [0x0] string for an empty input.
Ben Abbott <bpabbott@mac.com>
parents: 16768
diff changeset
80 if (num == 0)
16817
893e9cec62f1 Add missing semicolon to strjoin (missed in 7a97ff5ef42e).
Ben Abbott <bpabbott@mac.com>
parents: 16816
diff changeset
81 rval = "";
16815
7a97ff5ef42e strjoin() should return an empty [0x0] string for an empty input.
Ben Abbott <bpabbott@mac.com>
parents: 16768
diff changeset
82 else
7a97ff5ef42e strjoin() should return an empty [0x0] string for an empty input.
Ben Abbott <bpabbott@mac.com>
parents: 16768
diff changeset
83 rval = [[cstr(:).'; delimiter(:).']{:}];
7a97ff5ef42e strjoin() should return an empty [0x0] string for an empty input.
Ben Abbott <bpabbott@mac.com>
parents: 16768
diff changeset
84 endif
16400
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
85
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
86 endfunction
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
87
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
88 %!assert (strjoin ({"hello"}, "-"), "hello")
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
89 %!assert (strjoin ({"hello", "world"}), "hello world")
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
90 %!assert (strjoin ({"Octave", "Scilab", "Lush", "Yorick"}, "*"),
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
91 %! "Octave*Scilab*Lush*Yorick")
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
92 %!assert (strjoin ({"space", "comma", "dash", "semicolon", "done"},
424463a80134 New function strjoin.m
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
93 %! {" ", ",", "-", ";"}), "space comma,dash-semicolon;done")
16763
70ea511edbc4 strjoin.m: delimiter can include escape sequences (matlab compatibility)
Stefan Mahr <dac922@gmx.de>
parents: 16761
diff changeset
94 %!assert (strjoin ({'Octave','Scilab'},'\n'), "Octave\nScilab")
70ea511edbc4 strjoin.m: delimiter can include escape sequences (matlab compatibility)
Stefan Mahr <dac922@gmx.de>
parents: 16761
diff changeset
95 %!assert (strjoin ({'Octave','Scilab'},{'\n'}), "Octave\\nScilab")
16815
7a97ff5ef42e strjoin() should return an empty [0x0] string for an empty input.
Ben Abbott <bpabbott@mac.com>
parents: 16768
diff changeset
96 %!assert (strjoin ({},'foo'), "")