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

annotate scripts/strings/base2dec.m @ 13164:36afcd6fc45f

Allow cellstr inputs to *2dec conversion functions (Bug #34147). * base2dec.m, bin2dec.m, hex2dec.m: Allow cellstr inputs. Amend documentation for new feature and add test for new behavior.

author	Rik <octave@nomad.inbox5.com>
date	Mon, 19 Sep 2011 17:15:07 -0700
parents	fd0a3ac60b0e
children	72c96de7a403

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11469 diff changeset	1 ## Copyright (C) 2000-2011 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 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	5 ## 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	6 ## 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	7 ## 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	8 ## 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
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	13 ## General Public License for more details.
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
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	17 ## <http://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 --
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 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)
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: 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
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	32 ## row of @var{s}. If a row contains invalid symbols then the
13164 36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	33 ## corresponding value will be NaN@.
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
9036 58604c45ca74 Cleanup of data types related documentation Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	39 ## symbols for the digits of @var{s}. Space (' ') may not be used as a
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	40 ## symbol.
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	41 ##
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	42 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9036 diff changeset	43 ## @group
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	44 ## base2dec ("yyyzx", "xyz")
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	45 ## @result{} 123
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9036 diff changeset	46 ## @end group
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	47 ## @end example
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	48 ## @seealso{dec2base, bin2dec, hex2dec}
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	49 ## @end deftypefn
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	50
3791 c1c532a0acb2 [project @ 2001-02-09 15:28:23 by jwe] jwe parents: 3789 diff changeset	51 ## Author: Daniel Calvelo <dcalvelo@yahoo.com>
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	52 ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	53
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	54 function out = base2dec (s, base)
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	55
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	56 if (nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	57 print_usage ();
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	58 endif
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	59
13164 36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	60 if (iscellstr (s))
36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	61 s = char (s);
36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	62 elseif (! ischar (s))
36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	63 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	64 endif
36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	65
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	66 symbols = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
5443 ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe] jwe parents: 5307 diff changeset	67 if (ischar (base))
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	68 symbols = base;
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	69 base = length (symbols);
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	70 if (length (unique (symbols)) != base)
8664 e07e93c04080 style fixes John W. Eaton <jwe@octave.org> parents: 8442 diff changeset	71 error ("base2dec: symbols representing digits must be unique");
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	72 endif
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	73 if (any (isspace (symbols)))
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	74 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	75 endif
4030 22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe] jwe parents: 3791 diff changeset	76 elseif (! isscalar (base))
8664 e07e93c04080 style fixes John W. Eaton <jwe@octave.org> parents: 8442 diff changeset	77 error ("base2dec: cannot convert from several bases at once");
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	78 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	79 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	80 else
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	81 s = toupper (s);
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	82 endif
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	83
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	84 ## Right justify the values before anything else.
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	85 s = strjust (s, "right");
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	86
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	87 ## Lookup value of symbols in symbol table, with invalid symbols
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	88 ## 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	89 table = NaN (1, 256);
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	90 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	91 table(toascii (" ")) = 0;
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	92 s = table(toascii (s));
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	93
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	94 ## 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	95 ## and sum the rows.
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	96 out = s * (base .^ (columns(s)-1 : -1 : 0)');
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	97
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: diff changeset	98 endfunction
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	99
13164 36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	100
8442 502e58a0d44f Fix docstrings, add examples, references and tests to string functions Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	101 %!assert(base2dec ("11120", 3), 123);
9036 58604c45ca74 Cleanup of data types related documentation Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	102 %!assert(base2dec ("yyyzx", "xyz"), 123);
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	103 %!assert(base2dec ("-1", 2), NaN);
13164 36afcd6fc45f Allow cellstr inputs to 2dec conversion functions (Bug #34147). Rik <octave@nomad.inbox5.com>* parents: 11523 diff changeset	104 %!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	105
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	106 %%Test input validation
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	107 %!error base2dec ();
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	108 %!error base2dec ("11120");
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	109 %!error base2dec ("11120", 3, 4);
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	110 %!error base2dec ("11120", "1231");
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	111 %!error base2dec ("11120", "12 3");
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	112 %!error base2dec ("11120", ones(2));
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	113 %!error base2dec ("11120", 37);
7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	114

Mercurial > octave-antonio

annotate scripts/strings/base2dec.m @ 13164:36afcd6fc45f