octave-antonio: scripts/strings/strtrim.m annotate

annotate scripts/strings/strtrim.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	4197fc428c7d
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19593 diff changeset	1 ## Copyright (C) 1996-2015 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})
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	21 ## Remove leading and trailing whitespace from @var{s}.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	22 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	23 ## If @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	24 ## longest string. If @var{s} is a cell array of strings, operate recursively
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	25 ## on each string element.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	26 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	27 ## For example:
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7666 diff changeset	28 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7666 diff changeset	29 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7666 diff changeset	30 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7666 diff changeset	31 ## 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	32 ## @result{} "abc"
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7666 diff changeset	33 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7666 diff changeset	34 ## 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	35 ## @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	36 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7666 diff changeset	37 ## @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	38 ## @seealso{deblank}
7346 40252ccfcb67 [project @ 2008-01-04 20:26:25 by jwe] jwe parents: 7017 diff changeset	39 ## @end deftypefn
6975 0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	40
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	41 ## Author: John Swensen <jpswensen@jhu.edu>
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	42
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	43 ## This function was derived from deblank.
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	44
13159 a8184fb6b0c7 strtrim.m: Rename function inside .m file to match filename. Rik <octave@nomad.inbox5.com> parents: 13158 diff changeset	45 function s = strtrim (s)
6975 0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	46
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	47 if (nargin != 1)
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	48 print_usage ();
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	49 endif
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	50
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	51 if (ischar (s))
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	52
12876 29cd5a828bb2 strtrim.m: Don't remove nuls (\0) from string. Rik <octave@nomad.inbox5.com> parents: 12874 diff changeset	53 k = find (! isspace (s));
6975 0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	54 if (isempty (s) \|\| isempty (k))
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	55 s = "";
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	56 else
12874 d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays. Rik <octave@nomad.inbox5.com> parents: 12867 diff changeset	57 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	58 endif
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	59
13158 a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123). Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	60 elseif (iscell (s))
6975 0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	61
13158 a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123). Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	62 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	63 cell_idx = cellfun ("isclass", s, "cell");
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	64 if (! all (char_idx \| cell_idx))
13158 a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123). Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	65 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	66 endif
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123). Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	67
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123). Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	68 ## 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	69 ## and avoided where possible.
a1049e4480f8 strtrim.m: Allow operation on nested cellstr arrays (Bug #34123). Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	70 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	71 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	72
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	73 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	74 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	75 endif
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	76
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe] jwe parents: diff changeset	77 endfunction
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7666 diff changeset	78
12874 d5d3f04a645f strtrim.m: Make behavior same for cell arrays as for char arrays. Rik <octave@nomad.inbox5.com> parents: 12867 diff changeset	79
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	80 %!assert (strtrim (" abc "), "abc")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	81 %!assert (strtrim (" "), "")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	82 %!assert (strtrim ("abc"), "abc")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	83 %!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	84 %!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	85 %!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	86
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	87 %!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	88 %!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	89 %!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	90 %!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	91

Mercurial > octave-antonio

annotate scripts/strings/strtrim.m @ 20164:df437a52bcaf stable