Mercurial > octave-nkf

annotate scripts/strings/strjust.m @ 13318:f3b665972bb5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
strjust.m: Tweak code for performance. Add more input validation and tests. * strjust.m: Use repmat for faster array construction. Simplify code by using default values to function. Validate input is 2-D character string.
author Rik <octave@nomad.inbox5.com>
date Tue, 11 Oct 2011 12:46:24 -0700
parents c792872f8942
children 72c96de7a403
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11469
diff changeset
1 ## Copyright (C) 2000-2011 Paul Kienzle
10020
ffee051323f8 rewrite strjust
Jaroslav Hajek <highegg@gmail.com>
parents: 10018
diff changeset
2 ## Copyright (C) 2009 Jaroslav Hajek
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
3 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
4 ## This file is part of Octave.
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
5 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
7 ## 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
8 ## 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
9 ## your option) any later version.
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
10 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
14 ## General Public License for more details.
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
15 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
16 ## 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
17 ## 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
18 ## <http://www.gnu.org/licenses/>.
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
19
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
13318
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
21 ## @deftypefn {Function File} {} strjust (@var{s})
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
22 ## @deftypefnx {Function File} {} strjust (@var{s}, @var{pos})
11150
564e998017f5 docstring fixes
John W. Eaton <jwe@octave.org>
parents: 11114
diff changeset
23 ## Return the text, @var{s}, justified according to @var{pos}, which may
564e998017f5 docstring fixes
John W. Eaton <jwe@octave.org>
parents: 11114
diff changeset
24 ## be @samp{"left"}, @samp{"center"}, or @samp{"right"}. If @var{pos}
13318
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
25 ## is omitted it defaults to @samp{"right"}.
11096
04c3aacbbc46 strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents: 10635
diff changeset
26 ##
11563
3c6e8aaa9555 Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
27 ## Null characters are replaced by spaces. All other character
11096
04c3aacbbc46 strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents: 10635
diff changeset
28 ## data are treated as non-white space.
04c3aacbbc46 strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents: 10635
diff changeset
29 ##
04c3aacbbc46 strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents: 10635
diff changeset
30 ## Example:
11563
3c6e8aaa9555 Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
31 ##
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
32 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
33 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
34 ## strjust (["a"; "ab"; "abc"; "abcd"])
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
35 ## @result{} ans =
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
36 ## a
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
37 ## ab
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
38 ## abc
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
39 ## abcd
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
40 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
41 ## @end example
11114
f7079e3b0227 strjust.m: Add "untabify" and "strrep" to @seealso{} in the doc-string.
Ben Abbott <bpabbott@mac.com>
parents: 11096
diff changeset
42 ## @seealso{deblank, strrep, strtrim, untabify}
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
43 ## @end deftypefn
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
44
13318
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
45 function y = strjust (s, pos = "right")
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
46
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
47 if (nargin < 1 || nargin > 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5568
diff changeset
48 print_usage ();
13318
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
49 elseif (! ischar (s) || ndims (s) > 2)
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
50 error ("strjust: S must be a string or 2-D character matrix");
10018
fb8834c12035 fix & improve strjust
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
51 endif
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
52
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11150
diff changeset
53 if (isempty (s))
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11150
diff changeset
54 y = s;
13318
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
55 return;
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
56 endif
10020
ffee051323f8 rewrite strjust
Jaroslav Hajek <highegg@gmail.com>
parents: 10018
diff changeset
57
13318
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
58 ## Apparently, Matlab considers nulls to be blanks as well; however, does
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
59 ## not preserve the nulls, but rather converts them to blanks. That's a
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
60 ## bit unexpected, but it allows simpler processing, because we can move
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
61 ## just the nonblank characters. So we'll do the same here.
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
62
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
63 [nr, nc] = size (s);
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
64 ## Find the indices of all nonblanks.
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
65 nonbl = s != " " & s != "\0";
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
66 [idx, jdx] = find (nonbl);
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
67
13318
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
68 if (strcmpi (pos, "right"))
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
69 ## We wish to find the maximum column index for each row. Because jdx is
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
70 ## sorted, we can take advantage of the fact that assignment is processed
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
71 ## sequentially and for duplicate indices the last value will remain.
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
72 maxs = repmat (nc, [nr, 1]);
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
73 maxs(idx) = jdx;
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
74 shift = nc - maxs;
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
75 elseif (strcmpi (pos, "left"))
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
76 ## See above for explanation.
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
77 mins = ones (nr, 1);
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
78 mins(flipud (idx(:))) = flipud (jdx(:));
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
79 shift = 1 - mins;
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
80 else
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
81 ## Use both of the above to achieve centering.
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
82 mins = ones (nr, 1);
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
83 mins(flipud (idx(:))) = flipud (jdx(:));
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
84 maxs = repmat (nc, [nr, 1]);
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
85 maxs(idx) = jdx;
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
86 shift = floor ((nc + 1 - maxs - mins) / 2);
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
87 endif
10018
fb8834c12035 fix & improve strjust
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
88
13318
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
89 ## Adjust the column indices.
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
90 jdx += shift(idx);
10018
fb8834c12035 fix & improve strjust
Jaroslav Hajek <highegg@gmail.com>
parents: 9036
diff changeset
91
13318
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
92 ## Create a blank matrix and position the nonblank characters.
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
93 y = repmat (" ", nr, nc);
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
94 y(sub2ind ([nr, nc], idx, jdx)) = s(nonbl);
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
95
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents:
diff changeset
96 endfunction
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
97
13318
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
98
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
99 %!assert (strjust (["a"; "ab"; "abc"; "abcd"]),
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
100 %! [" a";" ab"; " abc"; "abcd"]);
13318
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
101 %!assert (strjust ([" a"; " ab"; "abc"; "abcd"], "left"),
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
102 %! ["a "; "ab "; "abc "; "abcd"]);
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
103 %!assert (strjust (["a"; "ab"; "abc"; "abcd"], "CENTER"),
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7017
diff changeset
104 %! [" a "; " ab"; "abc "; "abcd"]);
13318
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
105 %!assert (strjust (["";""]), "");
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
106
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
107 %% Test input validation
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
108 %!error <Invalid call to strjust> strjust ()
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
109 %!error <Invalid call to strjust> strjust (["a";"ab"], "center", 1)
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
110 %!error <S must be a string> strjust (ones(3,3))
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
111 %!error <S must be a string> strjust (char (ones(3,3,3)))
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
112