octave: scripts/strings/base2dec.m annotate

annotate scripts/strings/base2dec.m @ 25234:b02d5a4c7452

base2dec.m: Improve input validation to reject NaN as a base (bug #53477). * base2dec.m: Change structure of input comparisons so that a base of NaN will fail. Add BIST test. Modify %!error BIST tests to look for a fail pattern.

author	Rik <rik@octave.org>
date	Thu, 12 Apr 2018 13:46:00 -0700
parents	6652d3823428
children	00f796120a6d

rev	line source
25054 6652d3823428 maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 24790 diff changeset	1 ## Copyright (C) 2000-2018 Daniel Calvelo
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	2 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	3 ## This file is part of Octave.
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	4 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23573 diff changeset	5 ## Octave is free software: you can redistribute it and/or modify it
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23573 diff changeset	7 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22489 diff changeset	8 ## (at your option) any later version.
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	9 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	10 ## 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	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22489 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22489 diff changeset	13 ## GNU General Public License for more details.
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	14 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	15 ## 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	16 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23573 diff changeset	17 ## <https://www.gnu.org/licenses/>.
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	18
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20164 diff changeset	20 ## @deftypefn {} {} base2dec (@var{s}, @var{base})
11469 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 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	23 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	24 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9036 diff changeset	25 ## @group
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	29 ## @end example
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	40 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	41 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9036 diff changeset	42 ## @group
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	48 ## @end deftypefn
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	49
3791 c1c532a0acb2 [project @ 2001-02-09 15:28:23 by jwe] jwe parents: 3789 diff changeset	50 ## Author: Daniel Calvelo <dcalvelo@yahoo.com>
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	51 ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	54
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	55 if (nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	56 print_usage ();
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	57 endif
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	65 symbols = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
5443 ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe] jwe parents: 5307 diff changeset	66 if (ischar (base))
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	67 symbols = base;
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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 e07e93c04080 style fixes John W. Eaton <jwe@octave.org> parents: 8442 diff changeset	70 error ("base2dec: symbols representing digits must be unique");
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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 22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe] jwe parents: 3791 diff changeset	75 elseif (! isscalar (base))
8664 e07e93c04080 style fixes John W. Eaton <jwe@octave.org> parents: 8442 diff changeset	76 error ("base2dec: cannot convert from several bases at once");
25234 b02d5a4c7452 base2dec.m: Improve input validation to reject NaN as a base (bug #53477). Rik <rik@octave.org> parents: 25054 diff changeset	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 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	81 endif
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	104
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	105 ## Lookup value of symbols in symbol table, with invalid symbols
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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);
24790 d331650ce389 Delete remaining uses of deprecated toascii function Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	108 table(double (symbols(1:base))) = 0 : base-1;
d331650ce389 Delete remaining uses of deprecated toascii function Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	109 table(double (" ")) = 0;
d331650ce389 Delete remaining uses of deprecated toascii function Mike Miller <mtmiller@octave.org> parents: 24534 diff changeset	110 s = reshape (table(double (s)), size (s));
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	115
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	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
23573 1b4f4ec53b4a use new script to tag fixed bugs in tests John W. Eaton <jwe@octave.org> parents: 23572 diff changeset	124 %!assert <*35621> (base2dec (["0"; "1"], 2), [0; 1])
14404 731e9e1539a8 base2dec.m: Fix incorrect bin2dec results (bug #35621). Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	125
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	126 ## Test input validation
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	127 %!error base2dec ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	128 %!error base2dec ("11120")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	129 %!error base2dec ("11120", 3, 4)
25234 b02d5a4c7452 base2dec.m: Improve input validation to reject NaN as a base (bug #53477). Rik <rik@octave.org> parents: 25054 diff changeset	130 %!error <symbols .* must be unique> base2dec ("11120", "1231")
b02d5a4c7452 base2dec.m: Improve input validation to reject NaN as a base (bug #53477). Rik <rik@octave.org> parents: 25054 diff changeset	131 %!error <whitespace characters are not valid> base2dec ("11120", "12 3")
b02d5a4c7452 base2dec.m: Improve input validation to reject NaN as a base (bug #53477). Rik <rik@octave.org> parents: 25054 diff changeset	132 %!error <cannot convert from several bases> base2dec ("11120", ones (2))
b02d5a4c7452 base2dec.m: Improve input validation to reject NaN as a base (bug #53477). Rik <rik@octave.org> parents: 25054 diff changeset	133 %!error <BASE must be between 2 and 36> base2dec ("11120", 1)
b02d5a4c7452 base2dec.m: Improve input validation to reject NaN as a base (bug #53477). Rik <rik@octave.org> parents: 25054 diff changeset	134 %!error <BASE must be between 2 and 36> base2dec ("11120", 37)
b02d5a4c7452 base2dec.m: Improve input validation to reject NaN as a base (bug #53477). Rik <rik@octave.org> parents: 25054 diff changeset	135 %!error <BASE must be between 2 and 36> base2dec ("11120", NaN)

Mercurial > octave

annotate scripts/strings/base2dec.m @ 25234:b02d5a4c7452