Mercurial > octave-nkf
annotate scripts/strings/strjust.m @ 11096:04c3aacbbc46
strjust.m: Clarify that justification applies to spaces and null characters.
author | Ben Abbott <bpabbott@mac.com> |
---|---|
date | Thu, 14 Oct 2010 06:48:02 -0700 |
parents | d1978e7364ad |
children | f7079e3b0227 |
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 -*- | |
11096
04c3aacbbc46
strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents:
10635
diff
changeset
|
21 ## @deftypefn {Function File} strjust (@var{s}) |
04c3aacbbc46
strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents:
10635
diff
changeset
|
22 ## @deftypefnx {Function File} strjust (@var{s}, "right") |
04c3aacbbc46
strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents:
10635
diff
changeset
|
23 ## Returns the text, S, justified to the right. |
04c3aacbbc46
strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents:
10635
diff
changeset
|
24 ## |
04c3aacbbc46
strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents:
10635
diff
changeset
|
25 ## @deftypefnx {Function File} strjust (@var{s}, "left") |
04c3aacbbc46
strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents:
10635
diff
changeset
|
26 ## Returns left justified text. |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
27 ## |
11096
04c3aacbbc46
strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents:
10635
diff
changeset
|
28 ## @deftypefnx {Function File} strjust (@var{s}, "center") |
04c3aacbbc46
strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents:
10635
diff
changeset
|
29 ## Returns center justified text. |
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 ## 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
|
32 ## 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
|
33 ## |
04c3aacbbc46
strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents:
10635
diff
changeset
|
34 ## Example: |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
35 ## @example |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
36 ## @group |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
37 ## 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
|
38 ## @result{} ans = |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
39 ## a |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
40 ## ab |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
41 ## abc |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
42 ## abcd |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
43 ## @end group |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
44 ## @end example |
11096
04c3aacbbc46
strjust.m: Clarify that justification applies to spaces and null characters.
Ben Abbott <bpabbott@mac.com>
parents:
10635
diff
changeset
|
45 ## @seealso{deblank, strtrim} |
3789 | 46 ## @end deftypefn |
47 | |
10020 | 48 function y = strjust (x, just) |
3789 | 49 |
50 if (nargin < 1 || nargin > 2) | |
6046 | 51 print_usage (); |
3789 | 52 endif |
53 | |
54 if (nargin == 1) | |
55 just = "right"; | |
10018 | 56 else |
57 just = tolower (just); | |
3789 | 58 endif |
59 | |
10018 | 60 if (ndims (x) != 2) |
10635
d1978e7364ad
Print name of function in error() string messages.
Rik <octave@nomad.inbox5.com>
parents:
10020
diff
changeset
|
61 error ("strjust: input must be a string or character matrix"); |
10018 | 62 endif |
3789 | 63 |
10018 | 64 if (isempty (x)) |
10020 | 65 y = x; |
66 else | |
67 ## Apparently, Matlab considers nulls to be blanks as well; however, does | |
68 ## not preserve the nulls, but rather converts them to blanks. That's a | |
69 ## bit unexpected, but it allows simpler processing, because we can move | |
70 ## just the nonblank characters. So we'll do the same here. | |
71 | |
72 [nr, nc] = size (x); | |
73 ## Find the indices of all nonblanks. | |
74 nonbl = x != " " & x != "\0"; | |
75 [idx, jdx] = find (nonbl); | |
3789 | 76 |
10020 | 77 if (strcmp (just, "right")) |
78 ## We wish to find the maximum column index for each row. Because jdx is | |
79 ## sorted, we can take advantage of the fact that assignment is processed | |
80 ## sequentially and for duplicate indices the last value will remain. | |
81 maxs = nc * ones (nr, 1); | |
82 maxs(idx) = jdx; | |
83 shift = nc - maxs; | |
84 elseif (strcmp (just, "left")) | |
85 ## See above for explanation. | |
86 mins = ones (nr, 1); | |
87 mins(flipud (idx(:))) = flipud (jdx(:)); | |
88 shift = 1 - mins; | |
89 else | |
90 ## Use both of the above. | |
91 mins = ones (nr, 1); | |
92 mins(flipud (idx(:))) = flipud (jdx(:)); | |
93 maxs = nc * ones (nr, 1); | |
94 maxs(idx) = jdx; | |
95 shift = floor ((nc + 1 - maxs - mins) / 2); | |
96 endif | |
10018 | 97 |
10020 | 98 ## Adjust the column indices. |
99 jdx += shift (idx); | |
10018 | 100 |
10020 | 101 ## Create a blank matrix and position the nonblank characters. |
102 y = " "(ones (1, nr), ones (1, nc)); | |
103 y(sub2ind ([nr, nc], idx, jdx)) = x(nonbl); | |
5568 | 104 endif |
3789 | 105 |
106 endfunction | |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
107 |
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
108 %!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
|
109 %!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
|
110 %!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
|
111 %! [" 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
|
112 %!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
|
113 %! [" a "; " ab"; "abc "; "abcd"]); |