octave-lyh: scripts/strings/strtrunc.m annotate

annotate scripts/strings/strtrunc.m @ 13298:86d18a3cc911

strtrunc.m: Recode for 28X speedup for cellstr inputs * strtrunc.m: Recode for 28X speedup for cellstr inputs

author	Rik <octave@nomad.inbox5.com>
date	Sat, 08 Oct 2011 12:37:34 -0700
parents	fd0a3ac60b0e
children	ceda1714a4ad

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11473 diff changeset	1 ## Copyright (C) 2006-2011 William Poetra Yoga Hadisoeseno
5674 86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	2 ##
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	3 ## This file is part of Octave.
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	4 ##
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
86adc85cc471 [project @ 2006-03-16 03:46:45 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: 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.
5674 86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	9 ##
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	13 ## General Public License for more details.
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	14 ##
86adc85cc471 [project @ 2006-03-16 03:46:45 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: 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/>.
5674 86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	18
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	20 ## @deftypefn {Function File} {} strtrunc (@var{s}, @var{n})
9036 58604c45ca74 Cleanup of data types related documentation Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	21 ## Truncate the character string @var{s} to length @var{n}. If @var{s}
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	22 ## is a char matrix, then the number of columns is adjusted.
5674 86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	23 ##
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	24 ## If @var{s} is a cell array of strings, then the operation is performed
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	25 ## on its members and the new cell array is returned.
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	26 ## @end deftypefn
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	27
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	28 function s = strtrunc (s, n)
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	29
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	30 if (nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5674 diff changeset	31 print_usage ();
5674 86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	32 endif
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	33
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	34 if (ischar (s))
13298 86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	35 if (n < columns (s))
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	36 s = s(:, 1:n);
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	37 endif
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	38 elseif (iscellstr (s))
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	39 ## Convoluted approach converts cellstr to char matrix, trims the character
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	40 ## matrix using indexing, and then converts back to cellstr with mat2cell.
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	41 ## This approach is 28X faster than using cellfun and recursive call to strtrunc
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	42 idx = cellfun ("length", s) > n;
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	43 s(idx) = mat2cell (char (s(idx))(:, 1:n), ones (sum (idx), 1));
5674 86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	44 else
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 9036 diff changeset	45 error ("strtrunc: S must be a character string or a cell array of strings");
5674 86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	46 endif
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	47
86adc85cc471 [project @ 2006-03-16 03:46:45 by jwe] jwe parents: diff changeset	48 endfunction
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	49
13298 86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	50
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	51 %!assert (strtrunc("abcdefg", 4), "abcd");
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	52 %!assert (strtrunc("abcdefg", 10), "abcdefg");
13298 86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	53 %!assert (strtrunc(char ("abcdef", "fedcba"), 3), ["abc"; "fed"]);
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	54 %!assert (strtrunc({"abcdef", "fedcba"}, 3), {"abc", "fed"});
13298 86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	55
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	56 %% Test input validation
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	57 %!error strtrunc ()
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	58 %!error strtrunc ("abcd")
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	59 %!error strtrunc ("abcd", 4, 5)
86d18a3cc911 strtrunc.m: Recode for 28X speedup for cellstr inputs Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	60 %!error <S must be a character string or a cell array of strings> strtrunc (1, 1)

Mercurial > hg > octave-lyh

annotate scripts/strings/strtrunc.m @ 13298:86d18a3cc911