Mercurial > octave-antonio
annotate scripts/strings/base2dec.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:
19593
diff
changeset
|
1 ## Copyright (C) 2000-2015 Daniel Calvelo |
3789 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
3789 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
3789 | 18 |
19 ## -*- texinfo -*- | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11172
diff
changeset
|
20 ## @deftypefn {Function File} {} base2dec (@var{s}, @var{base}) |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11172
diff
changeset
|
21 ## Convert @var{s} from a string of digits in base @var{base} to a decimal |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
22 ## integer (base 10). |
3789 | 23 ## |
24 ## @example | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9036
diff
changeset
|
25 ## @group |
3789 | 26 ## base2dec ("11120", 3) |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
27 ## @result{} 123 |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9036
diff
changeset
|
28 ## @end group |
3789 | 29 ## @end example |
30 ## | |
13164
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
31 ## If @var{s} is a string matrix, return a column vector with one value per |
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
32 ## row of @var{s}. If a row contains invalid symbols then the corresponding |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
33 ## value will be NaN@. |
13164
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
34 ## |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
35 ## If @var{s} is a cell array of strings, return a column vector with one |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
36 ## value per cell element in @var{s}. |
3789 | 37 ## |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11172
diff
changeset
|
38 ## If @var{base} is a string, the characters of @var{base} are used as the |
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
39 ## symbols for the digits of @var{s}. Space (' ') may not be used as a symbol. |
3789 | 40 ## |
41 ## @example | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9036
diff
changeset
|
42 ## @group |
3789 | 43 ## base2dec ("yyyzx", "xyz") |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
44 ## @result{} 123 |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9036
diff
changeset
|
45 ## @end group |
3789 | 46 ## @end example |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
47 ## @seealso{dec2base, bin2dec, hex2dec} |
3789 | 48 ## @end deftypefn |
49 | |
3791 | 50 ## Author: Daniel Calvelo <dcalvelo@yahoo.com> |
3789 | 51 ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk> |
52 | |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
53 function out = base2dec (s, base) |
3789 | 54 |
55 if (nargin != 2) | |
6046 | 56 print_usage (); |
3789 | 57 endif |
58 | |
13164
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
59 if (iscellstr (s)) |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
60 s = char (s); |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
61 elseif (! ischar (s)) |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
62 error ("base2dec: S must be a string or cellstring"); |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
63 endif |
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
64 |
3789 | 65 symbols = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"; |
5443 | 66 if (ischar (base)) |
3789 | 67 symbols = base; |
68 base = length (symbols); | |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
69 if (length (unique (symbols)) != base) |
8664 | 70 error ("base2dec: symbols representing digits must be unique"); |
3789 | 71 endif |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
72 if (any (isspace (symbols))) |
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
73 error ("base2dec: whitespace characters are not valid symbols"); |
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
74 endif |
4030 | 75 elseif (! isscalar (base)) |
8664 | 76 error ("base2dec: cannot convert from several bases at once"); |
3789 | 77 elseif (base < 2 || base > length (symbols)) |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
78 error ("base2dec: BASE must be between 2 and 36, or a string of symbols"); |
3789 | 79 else |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
80 s = toupper (s); |
3789 | 81 endif |
82 | |
14478
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
83 ## Right justify the values and squeeze out any spaces. |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
84 ## This looks complicated, but indexing solution is very fast |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
85 ## compared to alternatives which use cellstr or cellfun or looping. |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
86 [nr, nc] = size (s); |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
87 if (nc > 1) # Bug #35621 |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
88 s = s.'; |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
89 nonbl = s != " "; |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
90 num_nonbl = sum (nonbl); |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
91 nc = max (num_nonbl); |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
92 num_blank = nc - num_nonbl; |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
93 R = repmat ([1 2; 0 0], 1, nr); |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
94 R(2, 1:2:2*nr) = num_blank; |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
95 R(2, 2:2:2*nr) = num_nonbl; |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
96 idx = repelems ([false, true], R); |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
97 idx = reshape (idx, nc, nr); |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
98 |
14478
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
99 ## Create a blank matrix and position the nonblank characters. |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
100 s2 = repmat (" ", nc, nr); |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
101 s2(idx) = s(nonbl); |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
102 s = s2.'; |
e995b1c97e13
Fix regression in bin2dec which did not allow space-separated input.
Rik <octave@nomad.inbox5.com>
parents:
14404
diff
changeset
|
103 endif |
3789 | 104 |
105 ## Lookup value of symbols in symbol table, with invalid symbols | |
106 ## evaluating to NaN and space evaluating to 0. | |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
107 table = NaN (1, 256); |
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
108 table(toascii (symbols(1:base))) = 0 : base-1; |
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
109 table(toascii (" ")) = 0; |
14404
731e9e1539a8
base2dec.m: Fix incorrect bin2dec results (bug #35621).
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
110 s = reshape (table(toascii (s)), size (s)); |
3789 | 111 |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
112 ## Multiply the resulting digits by the appropriate power |
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
113 ## and sum the rows. |
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
114 out = s * (base .^ (columns(s)-1 : -1 : 0)'); |
3789 | 115 |
116 endfunction | |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7017
diff
changeset
|
117 |
13164
36afcd6fc45f
Allow cellstr inputs to *2dec conversion functions (Bug #34147).
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
118 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
119 %!assert (base2dec ("11120", 3), 123) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
120 %!assert (base2dec ("yyyzx", "xyz"), 123) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
121 %!assert (base2dec ("-1", 2), NaN) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
122 %!assert (base2dec ({"A1", "1A"}, 16), [161; 26]) |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
123 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
124 ## Bug #35621 |
14404
731e9e1539a8
base2dec.m: Fix incorrect bin2dec results (bug #35621).
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
125 %!assert (base2dec (["0"; "1"], 2), [0; 1]) |
731e9e1539a8
base2dec.m: Fix incorrect bin2dec results (bug #35621).
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
126 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
127 ## Test input validation |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
128 %!error base2dec () |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
129 %!error base2dec ("11120") |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
130 %!error base2dec ("11120", 3, 4) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
131 %!error base2dec ("11120", "1231") |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
132 %!error base2dec ("11120", "12 3") |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
133 %!error base2dec ("11120", ones (2)) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14327
diff
changeset
|
134 %!error base2dec ("11120", 37) |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
135 |