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

annotate scripts/strings/deblank.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
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	2 ##
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 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: 6046 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: 6046 diff changeset	8 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 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: 6046 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: 6046 diff changeset	17 ## <http://www.gnu.org/licenses/>.
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	18
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3215 diff changeset	19 ## -- texinfo --
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3215 diff changeset	20 ## @deftypefn {Function File} {} deblank (@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 trailing whitespace and nulls 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{deblank} trims each row to the length of
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	24 ## longest string. If @var{s} is a cell array of strings, operate
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	25 ## recursively on each string element.
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	26 ##
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	27 ## Examples:
13929 9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13162 diff changeset	28 ##
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 ## @example
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	30 ## @group
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	31 ## deblank (" abc ")
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"
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	33 ##
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	34 ## deblank ([" abc "; " def "])
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"]
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	36 ## @end group
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	37 ## @end example
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{strtrim}
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3215 diff changeset	39 ## @end deftypefn
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	40
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	41 ## Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
2355 c9f70d39255f [project @ 1996-08-20 23:30:54 by jwe] jwe parents: 2325 diff changeset	42 ## Adapted-By: jwe
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	43
5462 74804828df1a [project @ 2005-09-22 18:36:22 by jwe] jwe parents: 5443 diff changeset	44 function s = deblank (s)
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	45
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	46 if (nargin != 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 6023 diff changeset	47 print_usage ();
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	48 endif
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	49
12925 1c71c9bf0570 deblank.m: Speed up 15x on cellstr inputs. Restrict input to strings or cellstrings. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	50 if (ischar (s))
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	51
12925 1c71c9bf0570 deblank.m: Speed up 15x on cellstr inputs. Restrict input to strings or cellstrings. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	52 k = find (! isspace (s) & s != "\0");
1c71c9bf0570 deblank.m: Speed up 15x on cellstr inputs. Restrict input to strings or cellstrings. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	53 if (isempty (s) \|\| isempty (k))
1c71c9bf0570 deblank.m: Speed up 15x on cellstr inputs. Restrict input to strings or cellstrings. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	54 s = "";
1c71c9bf0570 deblank.m: Speed up 15x on cellstr inputs. Restrict input to strings or cellstrings. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	55 else
1c71c9bf0570 deblank.m: Speed up 15x on cellstr inputs. Restrict input to strings or cellstrings. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	56 s = s(:,1:ceil (max (k) / rows (s)));
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	57 endif
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	58
13162 4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	59 elseif (iscell (s))
5462 74804828df1a [project @ 2005-09-22 18:36:22 by jwe] jwe parents: 5443 diff changeset	60
13162 4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	61 char_idx = cellfun ("isclass", s, "char");
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	62 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	63 if (! all (char_idx \| cell_idx))
13162 4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	64 error ("deblank: S argument must be a string or cellstring");
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	65 endif
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	66
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	67 ## Divide work load. Recursive cellfun deblank call is slow
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	68 ## and avoided where possible.
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	69 s(char_idx) = regexprep (s(char_idx), "[\\s\v\\0]+$", '');
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	70 s(cell_idx) = cellfun ("deblank", s(cell_idx), "UniformOutput", false);
5462 74804828df1a [project @ 2005-09-22 18:36:22 by jwe] jwe parents: 5443 diff changeset	71
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	72 else
12925 1c71c9bf0570 deblank.m: Speed up 15x on cellstr inputs. Restrict input to strings or cellstrings. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	73 error ("deblank: S argument must be a string or cellstring");
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	74 endif
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	75
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	76 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	77
7429 744f522dbabe [project @ 2008-01-30 07:44:07 by jwe] jwe parents: 7411 diff changeset	78
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	79 %!assert (deblank (" f o o \0"), " f o o")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	80 %!assert (deblank (' '), '')
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	81 %!assert (deblank (" "), "")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	82 %!assert (deblank (""), "")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	83 %!assert (deblank ({}), {})
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	84 %!assert (deblank ({" abc ", {" def "}}), {" abc", {" def"}})
7429 744f522dbabe [project @ 2008-01-30 07:44:07 by jwe] jwe parents: 7411 diff changeset	85
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	86 %!error <Invalid call to deblank> deblank ()
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 deblank> deblank ("foo", "bar")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	88 %!error <argument must be a string> deblank (1)
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> deblank ({[]})
7429 744f522dbabe [project @ 2008-01-30 07:44:07 by jwe] jwe parents: 7411 diff changeset	90

Mercurial > octave-antonio

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