Mercurial > octave-nkf
annotate scripts/strings/strjoin.m @ 17338:1c89599167a6
maint: End m-files with 1 blank line.
Simplifies automated grammarchecking script.
* scripts/@ftp/ascii.m, scripts/@ftp/binary.m, scripts/@ftp/cd.m,
scripts/@ftp/close.m, scripts/@ftp/delete.m, scripts/@ftp/dir.m,
scripts/@ftp/display.m, scripts/@ftp/ftp.m, scripts/@ftp/loadobj.m,
scripts/@ftp/mget.m, scripts/@ftp/mkdir.m, scripts/@ftp/mput.m,
scripts/@ftp/rename.m, scripts/@ftp/rmdir.m, scripts/@ftp/saveobj.m,
scripts/audio/lin2mu.m, scripts/audio/loadaudio.m, scripts/audio/mu2lin.m,
scripts/audio/record.m, scripts/audio/saveaudio.m, scripts/audio/setaudio.m,
scripts/deprecated/__error_text__.m, scripts/deprecated/cut.m,
scripts/deprecated/error_text.m, scripts/deprecated/isstr.m,
scripts/deprecated/polyderiv.m, scripts/deprecated/studentize.m,
scripts/deprecated/sylvester_matrix.m, scripts/general/bicubic.m,
scripts/general/celldisp.m, scripts/general/colon.m,
scripts/general/cplxpair.m, scripts/general/del2.m, scripts/general/display.m,
scripts/general/isdir.m, scripts/general/isequaln.m, scripts/general/loadobj.m,
scripts/general/private/__isequal__.m, scripts/general/private/__splinen__.m,
scripts/general/profexplore.m, scripts/general/quadgk.m,
scripts/general/randi.m, scripts/general/repmat.m, scripts/general/saveobj.m,
scripts/geometry/delaunay.m, scripts/help/__unimplemented__.m,
scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m,
scripts/help/help.m, scripts/help/print_usage.m,
scripts/help/private/__additional_help_message__.m,
scripts/help/private/__strip_html_tags__.m, scripts/help/type.m,
scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m,
scripts/image/imwrite.m, scripts/image/private/__imfinfo__.m,
scripts/image/private/__imread__.m, scripts/image/private/__imwrite__.m,
scripts/image/private/imageIO.m, scripts/image/private/imwrite_filename.m,
scripts/image/private/ind2x.m, scripts/io/beep.m, scripts/io/strread.m,
scripts/io/textread.m, scripts/io/textscan.m, scripts/linear-algebra/krylov.m,
scripts/linear-algebra/subspace.m, scripts/miscellaneous/bug_report.m,
scripts/miscellaneous/bunzip2.m, scripts/miscellaneous/cast.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dir.m, scripts/miscellaneous/dump_prefs.m,
scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m,
scripts/miscellaneous/gunzip.m, scripts/miscellaneous/isdeployed.m,
scripts/miscellaneous/ismac.m, scripts/miscellaneous/mex.m,
scripts/miscellaneous/mexext.m, scripts/miscellaneous/mkoctfile.m,
scripts/miscellaneous/movefile.m, scripts/miscellaneous/namelengthmax.m,
scripts/miscellaneous/news.m, scripts/miscellaneous/pack.m,
scripts/miscellaneous/perl.m,
scripts/miscellaneous/private/display_info_file.m,
scripts/miscellaneous/python.m, scripts/miscellaneous/rmappdata.m,
scripts/miscellaneous/run.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tempname.m, scripts/miscellaneous/untar.m,
scripts/miscellaneous/unzip.m, scripts/miscellaneous/what.m,
scripts/miscellaneous/zip.m, scripts/optimization/fminunc.m,
scripts/optimization/fsolve.m, scripts/optimization/fzero.m,
scripts/optimization/glpk.m, scripts/optimization/optimget.m,
scripts/optimization/optimset.m, scripts/optimization/qp.m,
scripts/optimization/sqp.m, scripts/path/pathdef.m, scripts/pkg/pkg.m,
scripts/pkg/private/build.m, scripts/pkg/private/describe.m,
scripts/pkg/private/dirempty.m, scripts/pkg/private/get_forge_download.m,
scripts/pkg/private/get_forge_pkg.m,
scripts/pkg/private/get_unsatisfied_deps.m, scripts/pkg/private/install.m,
scripts/pkg/private/is_architecture_dependent.m,
scripts/pkg/private/list_forge_packages.m, scripts/pkg/private/rebuild.m,
scripts/pkg/private/shell.m, scripts/pkg/private/uninstall.m,
scripts/plot/axes.m, scripts/plot/box.m, scripts/plot/closereq.m,
scripts/plot/diffuse.m, scripts/plot/ezpolar.m, scripts/plot/findfigs.m,
scripts/plot/gco.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/linkprop.m, scripts/plot/peaks.m,
scripts/plot/print.m, scripts/plot/private/__add_datasource__.m,
scripts/plot/private/__axis_label__.m, scripts/plot/private/__clabel__.m,
scripts/plot/private/__color_str_rgb__.m, scripts/plot/private/__contour__.m,
scripts/plot/private/__default_plot_options__.m,
scripts/plot/private/__errcomm__.m, scripts/plot/private/__file_filter__.m,
scripts/plot/private/__fltk_file_filter__.m,
scripts/plot/private/__getlegenddata__.m,
scripts/plot/private/__gnuplot_open_stream__.m,
scripts/plot/private/__gnuplot_print__.m,
scripts/plot/private/__go_draw_axes__.m,
scripts/plot/private/__interp_cube__.m, scripts/plot/private/__is_function__.m,
scripts/plot/private/__line__.m, scripts/plot/private/__marching_cube__.m,
scripts/plot/private/__next_line_style__.m, scripts/plot/private/__patch__.m,
scripts/plot/private/__pie__.m, scripts/plot/private/__pltopt__.m,
scripts/plot/private/__quiver__.m, scripts/plot/private/__scatter__.m,
scripts/plot/private/__stem__.m, scripts/plot/private/__uigetdir_fltk__.m,
scripts/plot/private/__uigetfile_fltk__.m,
scripts/plot/private/__uiobject_split_args__.m,
scripts/plot/private/__uiputfile_fltk__.m, scripts/plot/refresh.m,
scripts/plot/saveas.m, scripts/plot/shg.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/uicontextmenu.m, scripts/plot/uicontrol.m, scripts/plot/uipanel.m,
scripts/plot/uipushtool.m, scripts/plot/uiresume.m,
scripts/plot/uitoggletool.m, scripts/plot/uitoolbar.m, scripts/plot/uiwait.m,
scripts/plot/waitforbuttonpress.m, scripts/polynomial/pchip.m,
scripts/polynomial/polyeig.m, scripts/polynomial/ppval.m,
scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m,
scripts/prefs/private/loadprefs.m, scripts/prefs/private/prefsfile.m,
scripts/prefs/private/saveprefs.m, scripts/prefs/setpref.m,
scripts/set/private/validargs.m, scripts/set/unique.m,
scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m,
scripts/signal/arch_test.m, scripts/signal/arma_rnd.m,
scripts/signal/durbinlevinson.m, scripts/signal/fractdiff.m,
scripts/signal/freqz.m, scripts/signal/freqz_plot.m, scripts/signal/hurst.m,
scripts/signal/periodogram.m, scripts/signal/private/rectangle_lw.m,
scripts/signal/private/rectangle_sw.m, scripts/signal/private/triangle_sw.m,
scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m,
scripts/signal/stft.m, scripts/signal/synthesis.m, scripts/signal/yulewalker.m,
scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m,
scripts/sparse/gmres.m, scripts/sparse/private/__sprand_impl__.m,
scripts/sparse/spdiags.m, scripts/sparse/sprandn.m, scripts/specfun/bessel.m,
scripts/specfun/betaln.m, scripts/specfun/expint.m,
scripts/special-matrix/gallery.m, scripts/startup/__finish__.m,
scripts/statistics/base/qqplot.m, scripts/statistics/distributions/tcdf.m,
scripts/statistics/distributions/wienrnd.m,
scripts/statistics/models/logistic_regression.m,
scripts/statistics/models/private/logistic_regression_derivatives.m,
scripts/statistics/models/private/logistic_regression_likelihood.m,
scripts/statistics/tests/anova.m, scripts/statistics/tests/bartlett_test.m,
scripts/statistics/tests/chisquare_test_homogeneity.m,
scripts/statistics/tests/chisquare_test_independence.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/f_test_regression.m,
scripts/statistics/tests/hotelling_test.m,
scripts/statistics/tests/hotelling_test_2.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/manova.m, scripts/statistics/tests/mcnemar_test.m,
scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/run_test.m,
scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m,
scripts/statistics/tests/t_test_2.m,
scripts/statistics/tests/t_test_regression.m,
scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m,
scripts/statistics/tests/welch_test.m,
scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m,
scripts/statistics/tests/z_test_2.m, scripts/strings/strcat.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,
scripts/time/clock.m, scripts/time/datenum.m, scripts/ui/errordlg.m,
scripts/ui/private/message_dialog.m: End m-files with 1 blank line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 28 Aug 2013 08:33:02 -0700 |
| parents | 088d014a7fe2 |
| children | 1874a5a142ee |
| 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} | |
|
16826
a4969508008e
doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents:
16817
diff
changeset
|
27 ## separated by a space. |
| 16400 | 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 | |
|
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 | 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}; | |
|
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 |
| 16400 | 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) |
|
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 |