Mercurial > octave-antonio
annotate scripts/strings/strjoin.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 |
|---|---|
| 16768 | 1 ## Copyright (C) 2007 Muthiah Annamalai |
|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19593
diff
changeset
|
2 ## Copyright (C) 2013-2015 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}) |
|
18186
1874a5a142ee
doc: Fix documentation for strsplit (bug #41062).
Rik <rik@octave.org>
parents:
17338
diff
changeset
|
23 ## Join the elements of the cell string array, @var{cstr}, into a single |
| 16400 | 24 ## string. |
| 25 ## | |
|
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
26 ## If no @var{delimiter} is specified, the elements of @var{cstr} are |
|
16826
a4969508008e
doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents:
16817
diff
changeset
|
27 ## separated by a space. |
| 16400 | 28 ## |
|
18186
1874a5a142ee
doc: Fix documentation for strsplit (bug #41062).
Rik <rik@octave.org>
parents:
17338
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 | 31 ## |
|
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
32 ## If @var{delimiter} is a cell string array whose length is one less than |
|
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
33 ## @var{cstr}, then the elements of @var{cstr} are joined by interleaving the |
|
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
34 ## cell string elements of @var{delimiter}. Escape sequences are not |
|
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
35 ## 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 | |
|
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
43 ## @seealso{strsplit} |
| 16400 | 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}; | |
|
17312
088d014a7fe2
Use semicolon after "return" statement in core m-files.
Rik <rik@octave.org>
parents:
17306
diff
changeset
|
61 return; |
| 16400 | 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}; |
|
17306
09543e9c8f40
Use explicit form of end (endif, endfor, etc.) in core m-files.
Rik <rik@octave.org>
parents:
16826
diff
changeset
|
67 endif |
|
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
18186
diff
changeset
|
68 |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
18186
diff
changeset
|
69 num = numel (cstr); |
| 16400 | 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) |
|
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 | 85 |
| 86 endfunction | |
| 87 | |
|
17338
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
17312
diff
changeset
|
88 |
| 16400 | 89 %!assert (strjoin ({"hello"}, "-"), "hello") |
| 90 %!assert (strjoin ({"hello", "world"}), "hello world") | |
| 91 %!assert (strjoin ({"Octave", "Scilab", "Lush", "Yorick"}, "*"), | |
| 92 %! "Octave*Scilab*Lush*Yorick") | |
| 93 %!assert (strjoin ({"space", "comma", "dash", "semicolon", "done"}, | |
| 94 %! {" ", ",", "-", ";"}), "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
|
95 %!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
|
96 %!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
|
97 %!assert (strjoin ({},'foo'), "") |
|
17338
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
17312
diff
changeset
|
98 |