annotate scripts/strings/strtrim.m @ 14363:f3d52523cde1

Use Octave coding conventions in all m-file %!test blocks * wavread.m, acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m, asec.m, asecd.m, asech.m, asind.m, atand.m, cosd.m, cot.m, cotd.m, coth.m, csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m, accumarray.m, accumdim.m, bitcmp.m, bitget.m, bitset.m, blkdiag.m, cart2pol.m, cart2sph.m, celldisp.m, chop.m, circshift.m, colon.m, common_size.m, cplxpair.m, cumtrapz.m, curl.m, dblquad.m, deal.m, divergence.m, flipdim.m, fliplr.m, flipud.m, genvarname.m, gradient.m, idivide.m, int2str.m, interp1.m, interp1q.m, interp2.m, interp3.m, interpft.m, interpn.m, isa.m, isdir.m, isequal.m, isequalwithequalnans.m, issquare.m, logspace.m, nargchk.m, narginchk.m, nargoutchk.m, nextpow2.m, nthargout.m, num2str.m, pol2cart.m, polyarea.m, postpad.m, prepad.m, profile.m, profshow.m, quadgk.m, quadv.m, randi.m, rat.m, repmat.m, rot90.m, rotdim.m, shift.m, shiftdim.m, sph2cart.m, structfun.m, trapz.m, triplequad.m, convhull.m, dsearch.m, dsearchn.m, griddata3.m, griddatan.m, rectint.m, tsearchn.m, __makeinfo__.m, doc.m, get_first_help_sentence.m, help.m, type.m, unimplemented.m, which.m, imread.m, imwrite.m, dlmwrite.m, fileread.m, is_valid_file_id.m, strread.m, textread.m, textscan.m, commutation_matrix.m, cond.m, condest.m, cross.m, duplication_matrix.m, expm.m, housh.m, isdefinite.m, ishermitian.m, issymmetric.m, logm.m, normest.m, null.m, onenormest.m, orth.m, planerot.m, qzhess.m, rank.m, rref.m, trace.m, vech.m, ans.m, bincoeff.m, bug_report.m, bzip2.m, comma.m, compare_versions.m, computer.m, edit.m, fileparts.m, fullfile.m, getfield.m, gzip.m, info.m, inputname.m, isappdata.m, isdeployed.m, ismac.m, ispc.m, isunix.m, list_primes.m, ls.m, mexext.m, namelengthmax.m, news.m, orderfields.m, paren.m, recycle.m, rmappdata.m, semicolon.m, setappdata.m, setfield.m, substruct.m, symvar.m, ver.m, version.m, warning_ids.m, xor.m, fminbnd.m, fsolve.m, fzero.m, lsqnonneg.m, optimset.m, pqpnonneg.m, sqp.m, matlabroot.m, __gnuplot_drawnow__.m, __plt_get_axis_arg__.m, ancestor.m, cla.m, clf.m, close.m, colorbar.m, colstyle.m, comet3.m, contourc.m, figure.m, gca.m, gcbf.m, gcbo.m, gcf.m, ginput.m, graphics_toolkit.m, gtext.m, hggroup.m, hist.m, hold.m, isfigure.m, ishghandle.m, ishold.m, isocolors.m, isonormals.m, isosurface.m, isprop.m, legend.m, line.m, loglog.m, loglogerr.m, meshgrid.m, ndgrid.m, newplot.m, orient.m, patch.m, plot3.m, plotyy.m, __print_parse_opts__.m, quiver3.m, refreshdata.m, ribbon.m, semilogx.m, semilogxerr.m, semilogy.m, stem.m, stem3.m, subplot.m, title.m, uigetfile.m, view.m, whitebg.m, compan.m, conv.m, deconv.m, mkpp.m, mpoles.m, pchip.m, poly.m, polyaffine.m, polyder.m, polyfit.m, polygcd.m, polyint.m, polyout.m, polyval.m, polyvalm.m, ppder.m, ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, intersect.m, ismember.m, powerset.m, setdiff.m, setxor.m, union.m, unique.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m, fftconv.m, fftfilt.m, fftshift.m, freqz.m, hamming.m, hanning.m, ifftshift.m, sinc.m, sinetone.m, sinewave.m, unwrap.m, bicg.m, bicgstab.m, gmres.m, gplot.m, nonzeros.m, pcg.m, pcr.m, spaugment.m, spconvert.m, spdiags.m, speye.m, spfun.m, spones.m, sprand.m, sprandsym.m, spstats.m, spy.m, svds.m, treelayout.m, bessel.m, beta.m, betaln.m, factor.m, factorial.m, isprime.m, lcm.m, legendre.m, nchoosek.m, nthroot.m, perms.m, pow2.m, primes.m, reallog.m, realpow.m, realsqrt.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, rosser.m, vander.m, __finish__.m, center.m, cloglog.m, corr.m, cov.m, gls.m, histc.m, iqr.m, kendall.m, kurtosis.m, logit.m, mahalanobis.m, mean.m, meansq.m, median.m, mode.m, moment.m, ols.m, ppplot.m, prctile.m, probit.m, quantile.m, range.m, ranks.m, run_count.m, runlength.m, skewness.m, spearman.m, statistics.m, std.m, table.m, var.m, zscore.m, betacdf.m, betainv.m, betapdf.m, betarnd.m, binocdf.m, binoinv.m, binopdf.m, binornd.m, cauchy_cdf.m, cauchy_inv.m, cauchy_pdf.m, cauchy_rnd.m, chi2cdf.m, chi2inv.m, chi2pdf.m, chi2rnd.m, discrete_cdf.m, discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m, empirical_inv.m, empirical_pdf.m, empirical_rnd.m, expcdf.m, expinv.m, exppdf.m, exprnd.m, fcdf.m, finv.m, fpdf.m, frnd.m, gamcdf.m, gaminv.m, gampdf.m, gamrnd.m, geocdf.m, geoinv.m, geopdf.m, geornd.m, hygecdf.m, hygeinv.m, hygepdf.m, hygernd.m, kolmogorov_smirnov_cdf.m, laplace_cdf.m, laplace_inv.m, laplace_pdf.m, laplace_rnd.m, logistic_cdf.m, logistic_inv.m, logistic_pdf.m, logistic_rnd.m, logncdf.m, logninv.m, lognpdf.m, lognrnd.m, nbincdf.m, nbininv.m, nbinpdf.m, nbinrnd.m, normcdf.m, norminv.m, normpdf.m, normrnd.m, poisscdf.m, poissinv.m, poisspdf.m, poissrnd.m, stdnormal_cdf.m, stdnormal_inv.m, stdnormal_pdf.m, stdnormal_rnd.m, tcdf.m, tinv.m, tpdf.m, trnd.m, unidcdf.m, unidinv.m, unidpdf.m, unidrnd.m, unifcdf.m, unifinv.m, unifpdf.m, unifrnd.m, wblcdf.m, wblinv.m, wblpdf.m, wblrnd.m, kolmogorov_smirnov_test.m, kruskal_wallis_test.m, base2dec.m, bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m, findstr.m, hex2dec.m, index.m, isletter.m, mat2str.m, rindex.m, str2num.m, strcat.m, strjust.m, strmatch.m, strsplit.m, strtok.m, strtrim.m, strtrunc.m, substr.m, validatestring.m, demo.m, example.m, fail.m, speed.m, addtodate.m, asctime.m, clock.m, ctime.m, date.m, datenum.m, datetick.m, datevec.m, eomday.m, etime.m, is_leap_year.m, now.m: Use Octave coding conventions in all m-file %!test blocks
author Rik <octave@nomad.inbox5.com>
date Mon, 13 Feb 2012 07:29:44 -0800
parents 72c96de7a403
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13159
diff changeset
1 ## Copyright (C) 1996-2012 Kurt Hornik
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
2 ##
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
4 ##
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
6 ## 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: 6975
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6975
diff changeset
8 ## your option) any later version.
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
9 ##
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
14 ##
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
15 ## 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: 6975
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6975
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
18
7346
40252ccfcb67 [project @ 2008-01-04 20:26:25 by jwe]
jwe
parents: 7017
diff changeset
19 ## -*- texinfo -*-
7666
693ac94c2854 Fixed minor bugs in help texts of [x|y|z]lim and strtrim
sh@sh-laptop
parents: 7346
diff changeset
20 ## @deftypefn {Function File} {} strtrim (@var{s})
12876
29cd5a828bb2 strtrim.m: Don't remove nuls (\0) from string.
Rik <octave@nomad.inbox5.com>
parents: 12874
diff changeset
21 ## Remove leading and trailing whitespace from @var{s}. If
7666
693ac94c2854 Fixed minor bugs in help texts of [x|y|z]lim and strtrim
sh@sh-laptop
parents: 7346
diff changeset
22 ## @var{s} is a matrix, @var{strtrim} trims each row to the length of
12981
4ec4096f65d1 doc: State that required input is cellstr, not cell, for strtrim and deblank (Bug #34038)
Rik <octave@nomad.inbox5.com>
parents: 12975
diff changeset
23 ## longest string. If @var{s} is a cell array of strings, operate recursively
4ec4096f65d1 doc: State that required input is cellstr, not cell, for strtrim and deblank (Bug #34038)
Rik <octave@nomad.inbox5.com>
parents: 12975
diff changeset
24 ## on each string element. For example:
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
25 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
26 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
27 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
28 ## strtrim (" abc ")
12981
4ec4096f65d1 doc: State that required input is cellstr, not cell, for strtrim and deblank (Bug #34038)
Rik <octave@nomad.inbox5.com>
parents: 12975
diff changeset
29 ## @result{} "abc"
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
30 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
31 ## strtrim ([" abc "; " def "])
12981
4ec4096f65d1 doc: State that required input is cellstr, not cell, for strtrim and deblank (Bug #34038)
Rik <octave@nomad.inbox5.com>
parents: 12975
diff changeset
32 ## @result{} ["abc " ; " def"]
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
33 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
34 ## @end example
12981
4ec4096f65d1 doc: State that required input is cellstr, not cell, for strtrim and deblank (Bug #34038)
Rik <octave@nomad.inbox5.com>
parents: 12975
diff changeset
35 ## @seealso{deblank}
7346
40252ccfcb67 [project @ 2008-01-04 20:26:25 by jwe]
jwe
parents: 7017
diff changeset
36 ## @end deftypefn
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
37
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
38 ## Author: John Swensen <jpswensen@jhu.edu>
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
39
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
40 ## This function was derived from deblank.
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
41
13159
a8184fb6b0c7 strtrim.m: Rename function inside .m file to match filename.
Rik <octave@nomad.inbox5.com>
parents: 13158
diff changeset
42 function s = strtrim (s)
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
43
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
44 if (nargin != 1)
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
45 print_usage ();
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
46 endif
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
47
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
48 if (ischar (s))
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
49
12876
29cd5a828bb2 strtrim.m: Don't remove nuls (\0) from string.
Rik <octave@nomad.inbox5.com>
parents: 12874
diff changeset
50 k = find (! isspace (s));
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
51 if (isempty (s) || isempty (k))
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
52 s = "";
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
53 else
12874
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
54 s = s(:, ceil (min (k) / rows (s)):ceil (max (k) / rows (s)));
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
55 endif
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
56
13158
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123).
Rik <octave@nomad.inbox5.com>
parents: 12981
diff changeset
57 elseif (iscell (s))
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
58
13158
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123).
Rik <octave@nomad.inbox5.com>
parents: 12981
diff changeset
59 char_idx = cellfun ("isclass", s, "char");
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123).
Rik <octave@nomad.inbox5.com>
parents: 12981
diff changeset
60 cell_idx = cellfun ("isclass", s, "cell");
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123).
Rik <octave@nomad.inbox5.com>
parents: 12981
diff changeset
61 if (! all (char_idx | cell_idx))
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123).
Rik <octave@nomad.inbox5.com>
parents: 12981
diff changeset
62 error ("strtrim: S argument must be a string or cellstring");
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123).
Rik <octave@nomad.inbox5.com>
parents: 12981
diff changeset
63 endif
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123).
Rik <octave@nomad.inbox5.com>
parents: 12981
diff changeset
64
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123).
Rik <octave@nomad.inbox5.com>
parents: 12981
diff changeset
65 ## Divide work load. Recursive cellfun strtrim call is slow
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123).
Rik <octave@nomad.inbox5.com>
parents: 12981
diff changeset
66 ## and avoided where possible.
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123).
Rik <octave@nomad.inbox5.com>
parents: 12981
diff changeset
67 s(char_idx) = regexprep (s(char_idx), "^[\\s\v]+|[\\s\v]+$", '');
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123).
Rik <octave@nomad.inbox5.com>
parents: 12981
diff changeset
68 s(cell_idx) = cellfun ("strtrim", s(cell_idx), "UniformOutput", false);
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
69
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
70 else
12925
1c71c9bf0570 deblank.m: Speed up 15x on cellstr inputs. Restrict input to strings or cellstrings.
Rik <octave@nomad.inbox5.com>
parents: 12876
diff changeset
71 error ("strtrim: S argument must be a string or cellstring");
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
72 endif
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
73
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents:
diff changeset
74 endfunction
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7666
diff changeset
75
12874
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
76
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
77 %!assert (strtrim (" abc "), "abc")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
78 %!assert (strtrim (" "), "")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
79 %!assert (strtrim ("abc"), "abc")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
80 %!assert (strtrim ([" abc "; " def "]), ["abc "; " def"])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
81 %!assert (strtrim ({" abc "; " def "}), {"abc"; "def"})
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
82 %!assert (strtrim ({" abc ", {" def "}}), {"abc", {"def"}})
12874
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
83
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
84 %!error <Invalid call to strtrim> strtrim ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
85 %!error <Invalid call to strtrim> strtrim ("abc", "def")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
86 %!error <argument must be a string> strtrim (1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
87 %!error <argument must be a string> strtrim ({[]})
12874
d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays.
Rik <octave@nomad.inbox5.com>
parents: 12867
diff changeset
88