Mercurial > hg > octave-lyh
annotate scripts/strings/dec2base.m @ 11523:fd0a3ac60b0e
update copyright notices
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 14 Jan 2011 05:47:45 -0500 |
parents | c776f063fefe |
children | c792872f8942 |
rev | line source |
---|---|
11523 | 1 ## Copyright (C) 2000-2011 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} {} dec2base (@var{d}, @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 ## @deftypefnx {Function File} {} dec2base (@var{d}, @var{base}, @var{len}) |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11172
diff
changeset
|
22 ## Return a string of symbols in base @var{base} corresponding to |
11169
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
23 ## the non-negative integer @var{d}. |
3789 | 24 ## |
25 ## @example | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
26 ## @group |
3789 | 27 ## dec2base (123, 3) |
28 ## @result{} "11120" | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
29 ## @end group |
3789 | 30 ## @end example |
31 ## | |
11169
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
32 ## If @var{d} is a vector, return a string matrix with one row per value, |
3789 | 33 ## padded with leading zeros to the width of the largest value. |
34 ## | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11172
diff
changeset
|
35 ## If @var{base} is a string then the characters of @var{base} are used as |
11169
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
36 ## the symbols for the digits of @var{d}. Space (' ') may not be used |
3789 | 37 ## as a symbol. |
38 ## | |
39 ## @example | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
40 ## @group |
3789 | 41 ## dec2base (123, "aei") |
42 ## @result{} "eeeia" | |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
43 ## @end group |
3789 | 44 ## @end example |
4492 | 45 ## |
46 ## The optional third argument, @var{len}, specifies the minimum | |
47 ## number of digits in the result. | |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
11169
diff
changeset
|
48 ## @seealso{base2dec, dec2bin, dec2hex} |
3789 | 49 ## @end deftypefn |
50 | |
3791 | 51 ## Author: Daniel Calvelo <dcalvelo@yahoo.com> |
3789 | 52 ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk> |
53 | |
11169
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
54 function retval = dec2base (d, base, len) |
3789 | 55 |
4492 | 56 if (nargin < 2 || nargin > 3) |
6046 | 57 print_usage (); |
3789 | 58 endif |
59 | |
11169
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
60 # Create column vector for algorithm |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
61 if (columns (d) > 1 || !isvector (d)) |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
62 d = d(:); |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
63 endif |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
64 |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
65 if (any (d < 0 | d != fix (d))) |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
66 error ("dec2base: input must be non-negative integers"); |
3789 | 67 endif |
68 | |
69 symbols = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"; | |
5443 | 70 if (ischar (base)) |
3789 | 71 symbols = base; |
72 base = length (symbols); | |
11169
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
73 if (length (unique (symbols)) != base) |
5407 | 74 error ("dec2base: symbols representing digits must be unique"); |
3789 | 75 endif |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
11169
diff
changeset
|
76 if (any (isspace (symbols))) |
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
11169
diff
changeset
|
77 error ("dec2base: whitespace characters are not valid symbols"); |
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
11169
diff
changeset
|
78 endif |
4030 | 79 elseif (! isscalar (base)) |
5407 | 80 error ("dec2base: cannot convert from several bases at once"); |
3789 | 81 elseif (base < 2 || base > length (symbols)) |
11169
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
82 error ("dec2base: BASE must be between 2 and 36, or a string of symbols"); |
3789 | 83 endif |
84 | |
5125 | 85 ## determine number of digits required to handle all numbers, can overflow |
86 ## by 1 digit | |
11169
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
87 max_len = round (log (max (max (d), 1)) ./ log (base)) + 1; |
4492 | 88 |
89 if (nargin == 3) | |
90 max_len = max (max_len, len); | |
91 endif | |
3789 | 92 |
93 ## determine digits for each number | |
11169
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
94 digits = zeros (length (d), max_len); |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
95 for k = max_len:-1:1 |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
96 digits(:,k) = mod(d, base); |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
97 d = round ((d - digits(:,k)) / base); |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
98 endfor |
3789 | 99 |
100 ## convert digits to symbols | |
4492 | 101 retval = reshape (symbols (digits+1), size (digits)); |
3789 | 102 |
5133 | 103 ## Check if the first element is the zero symbol. It seems possible |
104 ## that LEN is provided, and is less than the computed MAX_LEN and | |
105 ## MAX_LEN is computed to be one larger than necessary, so we would | |
106 ## have a leading zero to remove. But if LEN >= MAX_LEN, we should | |
107 ## not remove any leading zeros. | |
108 if ((nargin == 2 || (nargin == 3 && max_len > len)) | |
5400 | 109 && all (retval(:,1) == symbols(1)) && length (retval) != 1) |
5125 | 110 retval = retval(:,2:end); |
111 endif | |
112 | |
3789 | 113 endfunction |
5125 | 114 |
115 %!test | |
116 %! s0=''; | |
117 %! for n=1:13 | |
118 %! for b=2:16 | |
119 %! pp=dec2base(b^n+1,b); | |
120 %! assert(dec2base(b^n,b),['1',s0,'0']); | |
121 %! assert(dec2base(b^n+1,b),['1',s0,'1']); | |
122 %! end | |
123 %! s0=[s0,'0']; | |
124 %! end | |
125 | |
126 %!test | |
127 %! digits='0123456789ABCDEF'; | |
128 %! for n=1:13 | |
129 %! for b=2:16 | |
130 %! pm=dec2base(b^n-1,b); | |
131 %! assert(length(pm),n); | |
132 %! assert(all(pm==digits(b))); | |
133 %! end | |
134 %! end | |
135 | |
136 %!test | |
137 %! for b=2:16 | |
138 %! assert(dec2base(0,b),'0'); | |
139 %! end | |
140 | |
11169
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
141 %!assert(dec2base(0,2,4), "0000"); |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
142 %!assert(dec2base(2^51-1,2), ... |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
143 %! '111111111111111111111111111111111111111111111111111'); |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
144 %!assert(dec2base(uint64(2)^63-1,16), '7FFFFFFFFFFFFFFF'); |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
145 |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
11169
diff
changeset
|
146 %%Test input validation |
11169
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
147 %!error dec2base () |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
148 %!error dec2base (1) |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
149 %!error dec2base (1, 2, 3, 4) |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
150 %!error dec2base (-1) |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
151 %!error dec2base (1.1) |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
152 %!error dec2base (1,"ABA") |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
11169
diff
changeset
|
153 %!error dec2base (1,"A B") |
11169
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
154 %!error dec2base (1, ones(2)) |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
155 %!error dec2base (1, 1) |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
156 %!error dec2base (1, 37) |
51beeeff9027
Update dec2base to handle numbers up to 2^64-1.
Rik <octave@nomad.inbox5.com>
parents:
9844
diff
changeset
|
157 |