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

annotate scripts/strings/strjust.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	9fc020886ae9
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 2000-2015 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
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	24 ## be @qcode{"left"}, @qcode{"center"}, or @qcode{"right"}.
11096 04c3aacbbc46 strjust.m: Clarify that justification applies to spaces and null characters. Ben Abbott <bpabbott@mac.com> parents: 10635 diff changeset	25 ##
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	26 ## If @var{pos} is omitted it defaults to @qcode{"right"}.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	27 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	28 ## Null characters are replaced by spaces. All other character data are
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	29 ## treated as non-white space.
11096 04c3aacbbc46 strjust.m: Clarify that justification applies to spaces and null characters. Ben Abbott <bpabbott@mac.com> parents: 10635 diff changeset	30 ##
04c3aacbbc46 strjust.m: Clarify that justification applies to spaces and null characters. Ben Abbott <bpabbott@mac.com> parents: 10635 diff changeset	31 ## Example:
11563 3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	32 ##
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	33 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	34 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	35 ## strjust (["a"; "ab"; "abc"; "abcd"])
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	36 ## @result{}
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	37 ## " a"
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	38 ## " ab"
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	39 ## " abc"
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	40 ## "abcd"
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	41 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	42 ## @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	43 ## @seealso{deblank, strrep, strtrim, untabify}
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	44 ## @end deftypefn
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	45
13318 f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	46 function y = strjust (s, pos = "right")
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	47
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	48 if (nargin < 1 \|\| nargin > 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5568 diff changeset	49 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	50 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	51 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	52 endif
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	53
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 11150 diff changeset	54 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	55 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	56 return;
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	57 endif
10020 ffee051323f8 rewrite strjust Jaroslav Hajek <highegg@gmail.com> parents: 10018 diff changeset	58
13318 f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	59 ## 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	60 ## 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	61 ## 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	62 ## 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	63
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	64 [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	65 ## 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	66 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	67 [idx, jdx] = find (nonbl);
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	68
13318 f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	69 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	70 ## 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	71 ## 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	72 ## 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	73 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	74 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	75 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	76 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	77 ## 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	78 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	79 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	80 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	81 else
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	82 ## 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	83 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	84 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	85 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	86 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	87 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	88 endif
10018 fb8834c12035 fix & improve strjust Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	89
13318 f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	90 ## Adjust the column indices.
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	91 jdx += shift (idx);
10018 fb8834c12035 fix & improve strjust Jaroslav Hajek <highegg@gmail.com> parents: 9036 diff changeset	92
13318 f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	93 ## 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	94 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	95 y(sub2ind ([nr, nc], idx, jdx)) = s(nonbl);
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	96
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	97 endfunction
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	98
13318 f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	99
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	100 %!assert (strjust (["a"; "ab"; "abc"; "abcd"]),
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	101 %! [" 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	102 %!assert (strjust ([" a"; " ab"; "abc"; "abcd"], "left"),
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	103 %! ["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	104 %!assert (strjust (["a"; "ab"; "abc"; "abcd"], "CENTER"),
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	105 %! [" a "; " ab"; "abc "; "abcd"])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	106 %!assert (strjust (["";""]), "")
13318 f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	107
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	108 ## Test input validation
13318 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 ()
f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	110 %!error <Invalid call to strjust> strjust (["a";"ab"], "center", 1)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	111 %!error <S must be a string> strjust (ones (3,3))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	112 %!error <S must be a string> strjust (char (ones (3,3,3)))
13318 f3b665972bb5 strjust.m: Tweak code for performance. Add more input validation and tests. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	113

Mercurial > octave-antonio

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