Mercurial > octave-antonio
annotate scripts/strings/strjoin.m @ 16816:12005245b645
doc: Periodic grammarcheck of documentation.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/contrib.txi, doc/interpreter/diagperm.txi,
doc/interpreter/errors.txi, doc/interpreter/install.txi,
doc/interpreter/sparse.txi, libinterp/corefcn/ellipj.cc,
libinterp/corefcn/mappers.cc, libinterp/corefcn/regexp.cc,
libinterp/corefcn/tril.cc, libinterp/dldfcn/__init_fltk__.cc,
libinterp/dldfcn/fftw.cc, libinterp/interpfcn/dirfns.cc,
libinterp/interpfcn/input.cc, libinterp/octave-value/ov-fcn-inline.cc,
libinterp/octave-value/ov-struct.cc, scripts/@ftp/cd.m,
scripts/general/interp1.m, scripts/general/num2str.m, scripts/image/ind2rgb.m,
scripts/image/rgb2ind.m, scripts/io/importdata.m, scripts/io/textread.m,
scripts/java/javamem.m, scripts/linear-algebra/condest.m,
scripts/linear-algebra/onenormest.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/getfield.m, scripts/miscellaneous/setfield.m,
scripts/plot/area.m, scripts/plot/pcolor.m, scripts/plot/stairs.m,
scripts/set/powerset.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/specfun/ellipke.m,
scripts/special-matrix/gallery.m, scripts/strings/strjoin.m,
scripts/strings/strsplit.m, scripts/testfun/__have_feature__.m,
scripts/testfun/__printf_assert__.m, scripts/testfun/__prog_output_assert__.m,
scripts/testfun/__run_test_suite__.m: grammarcheck documentation.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sat, 22 Jun 2013 19:47:32 -0700 |
| parents | 7a97ff5ef42e |
| children | 893e9cec62f1 |
| rev | line source |
|---|---|
| 16768 | 1 ## Copyright (C) 2007 Muthiah Annamalai |
| 2 ## Copyright (C) 2013 Ben Abbott | |
| 16400 | 3 ## |
| 4 ## This file is part of Octave. | |
| 5 ## | |
| 6 ## Octave is free software; you can redistribute it and/or modify it | |
| 7 ## under the terms of the GNU General Public License as published by | |
| 8 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 9 ## your option) any later version. | |
| 10 ## | |
| 11 ## Octave is distributed in the hope that it will be useful, but | |
| 12 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 14 ## General Public License for more details. | |
| 15 ## | |
| 16 ## You should have received a copy of the GNU General Public License | |
| 17 ## along with Octave; see the file COPYING. If not, see | |
| 18 ## <http://www.gnu.org/licenses/>. | |
| 19 | |
| 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 | 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 | 24 ## string. |
| 25 ## | |
| 26 ## If no @var{delimiter} is specified, the elements of @var{cstr} | |
| 27 ## seperated by a space. | |
| 28 ## | |
| 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 | 31 ## |
| 32 ## If @var{delimiter} is a cell-string array whose length is one less | |
| 33 ## than @var{cstr}, then the elemennts 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 | 36 ## |
| 37 ## @example | |
| 38 ## @group | |
| 39 ## strjoin (@{'Octave','Scilab','Lush','Yorick'@}, '*') | |
| 40 ## @result{} 'Octave*Scilab*Lush*Yorick' | |
| 41 ## @end group | |
| 42 ## @end example | |
| 43 ## @seealso {strsplit} | |
| 44 ## @end deftypefn | |
| 45 | |
| 16768 | 46 ## Author: Muthiah Annamalai <muthiah.annamalai@uta.edu> |
| 47 ## Author: Ben Abbott <bpabbott@mac.com> | |
| 48 | |
| 16400 | 49 function rval = strjoin (cstr, delimiter) |
| 50 | |
| 51 if (nargin == 1) | |
| 52 delimiter = " "; | |
| 53 elseif (nargin < 1 || nargin > 2) | |
| 54 print_usage (); | |
| 55 elseif (! (iscellstr (cstr) && (ischar (delimiter) || iscellstr (delimiter)))) | |
| 56 print_usage (); | |
| 57 endif | |
| 58 | |
| 59 if (numel (cstr) == 1) | |
| 60 rval = cstr{1}; | |
| 61 return | |
| 62 endif | |
| 63 | |
| 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 | 66 delimiter = {delimiter}; |
| 67 end | |
| 68 | |
| 69 num = numel (cstr); | |
| 70 if (numel (delimiter) == 1 && num > 1) | |
| 71 delimiter = repmat (delimiter, 1, num); | |
| 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 | 74 error ("strjoin:cellstring_delimiter_mismatch", |
| 75 "strjoin: the number of delimiters does not match the number of strings") | |
| 76 else | |
| 77 delimiter(end+1) = {""}; | |
| 78 endif | |
| 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) |
|
7a97ff5ef42e
strjoin() should return an empty [0x0] string for an empty input.
Ben Abbott <bpabbott@mac.com>
parents:
16768
diff
changeset
|
81 rval = "" |
|
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 | 85 |
| 86 endfunction | |
| 87 | |
| 88 %!assert (strjoin ({"hello"}, "-"), "hello") | |
| 89 %!assert (strjoin ({"hello", "world"}), "hello world") | |
| 90 %!assert (strjoin ({"Octave", "Scilab", "Lush", "Yorick"}, "*"), | |
| 91 %! "Octave*Scilab*Lush*Yorick") | |
| 92 %!assert (strjoin ({"space", "comma", "dash", "semicolon", "done"}, | |
| 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'), "") |