Mercurial > octave-nkf
annotate scripts/strings/strjust.m @ 11469:c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sun, 09 Jan 2011 12:41:21 -0800 |
| parents | 564e998017f5 |
| children | fd0a3ac60b0e |
| rev | line source |
|---|---|
| 8920 | 1 ## Copyright (C) 2000, 2001, 2003, 2005, 2006, 2007, 2009 Paul Kienzle |
| 10020 | 2 ## Copyright (C) 2009 Jaroslav Hajek |
| 3789 | 3 ## |
| 4 ## This file is part of Octave. | |
| 5 ## | |
| 6 ## Octave is free software; you can redistribute it and/or modify it | |
| 7 ## under the terms of the GNU General Public License as published by | |
| 7016 | 8 ## the Free Software Foundation; either version 3 of the License, or (at |
| 9 ## your option) any later version. | |
| 3789 | 10 ## |
| 11 ## Octave is distributed in the hope that it will be useful, but | |
| 12 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 14 ## General Public License for more details. | |
| 15 ## | |
| 16 ## You should have received a copy of the GNU General Public License | |
| 7016 | 17 ## along with Octave; see the file COPYING. If not, see |
| 18 ## <http://www.gnu.org/licenses/>. | |
| 3789 | 19 |
| 20 ## -*- texinfo -*- | |
| 11150 | 21 ## @deftypefn {Function File} {} strjust (@var{s}, @var{pos}) |
| 22 ## Return the text, @var{s}, justified according to @var{pos}, which may | |
| 23 ## be @samp{"left"}, @samp{"center"}, or @samp{"right"}. If @var{pos} | |
| 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 ## |
|
04c3aacbbc46
strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents:
10635
diff
changeset
|
26 ## Null characters are replaced by spaces. All other character |
|
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: |
|
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
30 ## @example |
|
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
31 ## @group |
|
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
32 ## 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
|
33 ## @result{} ans = |
|
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
34 ## a |
|
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
35 ## ab |
|
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
36 ## abc |
|
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
37 ## abcd |
|
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
38 ## @end group |
|
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
39 ## @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
|
40 ## @seealso{deblank, strrep, strtrim, untabify} |
| 3789 | 41 ## @end deftypefn |
| 42 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11150
diff
changeset
|
43 function y = strjust (s, pos) |
| 3789 | 44 |
| 45 if (nargin < 1 || nargin > 2) | |
| 6046 | 46 print_usage (); |
| 3789 | 47 endif |
| 48 | |
| 49 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
|
50 pos = "right"; |
| 10018 | 51 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
|
52 pos = tolower (pos); |
| 3789 | 53 endif |
| 54 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11150
diff
changeset
|
55 if (ndims (s) != 2) |
|
10635
d1978e7364ad
Print name of function in error() string messages.
Rik <octave@nomad.inbox5.com>
parents:
10020
diff
changeset
|
56 error ("strjust: input must be a string or character matrix"); |
| 10018 | 57 endif |
| 3789 | 58 |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11150
diff
changeset
|
59 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
|
60 y = s; |
| 10020 | 61 else |
| 62 ## Apparently, Matlab considers nulls to be blanks as well; however, does | |
| 63 ## not preserve the nulls, but rather converts them to blanks. That's a | |
| 64 ## bit unexpected, but it allows simpler processing, because we can move | |
| 65 ## just the nonblank characters. So we'll do the same here. | |
| 66 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11150
diff
changeset
|
67 [nr, nc] = size (s); |
| 10020 | 68 ## 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
|
69 nonbl = s != " " & s != "\0"; |
| 10020 | 70 [idx, jdx] = find (nonbl); |
| 3789 | 71 |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11150
diff
changeset
|
72 if (strcmp (pos, "right")) |
| 10020 | 73 ## We wish to find the maximum column index for each row. Because jdx is |
| 74 ## sorted, we can take advantage of the fact that assignment is processed | |
| 75 ## sequentially and for duplicate indices the last value will remain. | |
| 76 maxs = nc * ones (nr, 1); | |
| 77 maxs(idx) = jdx; | |
| 78 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
|
79 elseif (strcmp (pos, "left")) |
| 10020 | 80 ## See above for explanation. |
| 81 mins = ones (nr, 1); | |
| 82 mins(flipud (idx(:))) = flipud (jdx(:)); | |
| 83 shift = 1 - mins; | |
| 84 else | |
| 85 ## Use both of the above. | |
| 86 mins = ones (nr, 1); | |
| 87 mins(flipud (idx(:))) = flipud (jdx(:)); | |
| 88 maxs = nc * ones (nr, 1); | |
| 89 maxs(idx) = jdx; | |
| 90 shift = floor ((nc + 1 - maxs - mins) / 2); | |
| 91 endif | |
| 10018 | 92 |
| 10020 | 93 ## Adjust the column indices. |
| 94 jdx += shift (idx); | |
| 10018 | 95 |
| 10020 | 96 ## Create a blank matrix and position the nonblank characters. |
| 97 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
|
98 y(sub2ind ([nr, nc], idx, jdx)) = s(nonbl); |
| 5568 | 99 endif |
| 3789 | 100 |
| 101 endfunction | |
|
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
102 |
|
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
103 %!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
|
104 %!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
|
105 %!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
|
106 %! [" 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 %!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
|
108 %! [" a "; " ab"; "abc "; "abcd"]); |