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

annotate scripts/strings/deblank.m @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012

author	John W. Eaton <jwe@octave.org>
date	Mon, 02 Jan 2012 14:25:41 -0500
parents	9cae456085c2
children	f3d52523cde1

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13929 diff changeset	1 ## Copyright (C) 1996-2012 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})
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	21 ## Remove trailing whitespace and nulls from @var{s}. If @var{s}
5462 74804828df1a [project @ 2005-09-22 18:36:22 by jwe] jwe parents: 5443 diff changeset	22 ## is a matrix, @var{deblank} trims each row to the length of longest
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 ## string. If @var{s} is a cell array of strings, operate recursively on each
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 ## string element.
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	25 ##
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 ## Examples:
13929 9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13162 diff changeset	27 ##
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	28 ## @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	29 ## @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	30 ## 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	31 ## @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	32 ##
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 ## 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	34 ## @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	35 ## @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	36 ## @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	37 ## @seealso{strtrim}
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3215 diff changeset	38 ## @end deftypefn
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	39
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	40 ## 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	41 ## Adapted-By: jwe
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	42
5462 74804828df1a [project @ 2005-09-22 18:36:22 by jwe] jwe parents: 5443 diff changeset	43 function s = deblank (s)
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	44
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	45 if (nargin != 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 6023 diff changeset	46 print_usage ();
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	47 endif
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	48
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	49 if (ischar (s))
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	50
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	51 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	52 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	53 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	54 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	55 s = s(:,1:ceil (max (k) / rows (s)));
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	56 endif
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	57
13162 4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	58 elseif (iscell (s))
5462 74804828df1a [project @ 2005-09-22 18:36:22 by jwe] jwe parents: 5443 diff changeset	59
13162 4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	60 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	61 cell_idx = cellfun ("isclass", s, "cell");
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	62 if (! all (char_idx \| cell_idx))
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	63 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	64 endif
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	65
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	66 ## 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	67 ## and avoided where possible.
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	68 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	69 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	70
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	71 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	72 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	73 endif
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	74
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	75 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	76
7429 744f522dbabe [project @ 2008-01-30 07:44:07 by jwe] jwe parents: 7411 diff changeset	77
13162 4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	78 %!assert (deblank (" f o o \0"), " f o o");
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	79 %!assert (deblank (' '), '');
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	80 %!assert (deblank (" "), "");
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	81 %!assert (deblank (""), "");
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	82 %!assert (deblank ({}), {});
4e92b71dcc97 deblank.m: Modified to accept nested cellstr arrays (Bug #34123) Rik <octave@nomad.inbox5.com> parents: 12981 diff changeset	83 %!assert (deblank ({" abc ", {" def "}}), {" abc", {" def"}});
7429 744f522dbabe [project @ 2008-01-30 07:44:07 by jwe] jwe parents: 7411 diff changeset	84
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	85 %!error <Invalid call to deblank> deblank ();
1c71c9bf0570 deblank.m: Speed up 15x on cellstr inputs. Restrict input to strings or cellstrings. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	86 %!error <Invalid call to deblank> deblank ("foo", "bar");
1c71c9bf0570 deblank.m: Speed up 15x on cellstr inputs. Restrict input to strings or cellstrings. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	87 %!error <argument must be a string> deblank (1);
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	88 %!error <argument must be a string> deblank ({[]});
7429 744f522dbabe [project @ 2008-01-30 07:44:07 by jwe] jwe parents: 7411 diff changeset	89

Mercurial > octave-nkf

annotate scripts/strings/deblank.m @ 14138:72c96de7a403 stable