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

annotate scripts/strings/strjust.m @ 11563:3c6e8aaa9555

Grammarcheck m-files before 3.4 release.

author	Rik <octave@nomad.inbox5.com>
date	Tue, 18 Jan 2011 20:55:01 -0800
parents	fd0a3ac60b0e
children	c792872f8942

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 --
11150 564e998017f5 docstring fixes John W. Eaton <jwe@octave.org> parents: 11114 diff changeset	21 ## @deftypefn {Function File} {} strjust (@var{s}, @var{pos})
564e998017f5 docstring fixes John W. Eaton <jwe@octave.org> parents: 11114 diff changeset	22 ## 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	23 ## be @samp{"left"}, @samp{"center"}, or @samp{"right"}. If @var{pos}
564e998017f5 docstring fixes John W. Eaton <jwe@octave.org> parents: 11114 diff changeset	24 ## is omitted, @samp{"right"} is assumed.
11096 04c3aacbbc46 strjust.m: Clarify that justification applies to spaces and null characters. Ben Abbott <bpabbott@mac.com> parents: 10635 diff changeset	25 ##
11563 3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	26 ## 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	27 ## 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	28 ##
04c3aacbbc46 strjust.m: Clarify that justification applies to spaces and null characters. Ben Abbott <bpabbott@mac.com> parents: 10635 diff changeset	29 ## Example:
11563 3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	30 ##
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	31 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	32 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	33 ## 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	34 ## @result{} ans =
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	35 ## a
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	36 ## ab
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	37 ## abc
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	38 ## abcd
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	39 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	40 ## @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	41 ## @seealso{deblank, strrep, strtrim, untabify}
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	42 ## @end deftypefn
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	43
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11150 diff changeset	44 function y = strjust (s, pos)
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	45
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	46 if (nargin < 1 \|\| nargin > 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5568 diff changeset	47 print_usage ();
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	48 endif
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	49
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	50 if (nargin == 1)
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11150 diff changeset	51 pos = "right";
10018 fb8834c12035 fix & improve strjust Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	52 else
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 pos = tolower (pos);
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	54 endif
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	55
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11150 diff changeset	56 if (ndims (s) != 2)
10635 d1978e7364ad Print name of function in error() string messages. Rik <octave@nomad.inbox5.com> parents: 10020 diff changeset	57 error ("strjust: input must be a string or character matrix");
10018 fb8834c12035 fix & improve strjust Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	58 endif
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	59
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11150 diff changeset	60 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	61 y = s;
10020 ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	62 else
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	63 ## Apparently, Matlab considers nulls to be blanks as well; however, does
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	64 ## not preserve the nulls, but rather converts them to blanks. That's a
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	65 ## bit unexpected, but it allows simpler processing, because we can move
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	66 ## just the nonblank characters. So we'll do the same here.
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	67
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11150 diff changeset	68 [nr, nc] = size (s);
10020 ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	69 ## Find the indices of all nonblanks.
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11150 diff changeset	70 nonbl = s != " " & s != "\0";
10020 ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	71 [idx, jdx] = find (nonbl);
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	72
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11150 diff changeset	73 if (strcmp (pos, "right"))
10020 ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	74 ## We wish to find the maximum column index for each row. Because jdx is
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	75 ## sorted, we can take advantage of the fact that assignment is processed
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	76 ## sequentially and for duplicate indices the last value will remain.
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	77 maxs = nc * ones (nr, 1);
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	78 maxs(idx) = jdx;
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	79 shift = nc - maxs;
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11150 diff changeset	80 elseif (strcmp (pos, "left"))
10020 ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	81 ## See above for explanation.
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	82 mins = ones (nr, 1);
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	83 mins(flipud (idx(:))) = flipud (jdx(:));
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	84 shift = 1 - mins;
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	85 else
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	86 ## Use both of the above.
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	87 mins = ones (nr, 1);
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	88 mins(flipud (idx(:))) = flipud (jdx(:));
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	89 maxs = nc * ones (nr, 1);
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	90 maxs(idx) = jdx;
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	91 shift = floor ((nc + 1 - maxs - mins) / 2);
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	92 endif
10018 fb8834c12035 fix & improve strjust Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	93
10020 ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	94 ## Adjust the column indices.
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	95 jdx += shift (idx);
10018 fb8834c12035 fix & improve strjust Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	96
10020 ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	97 ## Create a blank matrix and position the nonblank characters.
ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	98 y = " "(ones (1, nr), ones (1, nc));
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11150 diff changeset	99 y(sub2ind ([nr, nc], idx, jdx)) = s(nonbl);
5568 e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe] jwe parents: 5307 diff changeset	100 endif
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	101
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	102 endfunction
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	103
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	104 %!error <Invalid call to strjust> strjust();
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	105 %!error <Invalid call to strjust> strjust(["a";"ab"], "center", 1);
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	106 %!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	107 %! [" 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	108 %!assert (strjust (["a"; "ab"; "abc"; "abcd"], "center"),
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	109 %! [" a "; " ab"; "abc "; "abcd"]);

Mercurial > octave-antonio

annotate scripts/strings/strjust.m @ 11563:3c6e8aaa9555