Mercurial > octave
annotate scripts/strings/dec2bin.m @ 28237:ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
* dec2bin.m: Calculate "lt_zero_idx" which is index of any values in the input
less than zero just once. Use lt_zero_idx in all further indexing.
Add 4 %!xtest for input values which should work, but don't.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 22 Apr 2020 17:04:55 -0700 |
parents | 5bb1c0cbb27e |
children | ef7bc64a604b |
rev | line source |
---|---|
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
1 ######################################################################## |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
2 ## |
27919
1891570abac8
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
27918
diff
changeset
|
3 ## Copyright (C) 1996-2020 The Octave Project Developers |
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
4 ## |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
5 ## See the file COPYRIGHT.md in the top-level directory of this |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
6 ## distribution or <https://octave.org/copyright/>. |
2325 | 7 ## |
2313 | 8 ## This file is part of Octave. |
9 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
10 ## Octave is free software: you can redistribute it and/or modify it |
2313 | 11 ## 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:
23220
diff
changeset
|
12 ## the Free Software Foundation, either version 3 of the License, or |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
13 ## (at your option) any later version. |
2313 | 14 ## |
15 ## Octave is distributed in the hope that it will be useful, but | |
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
18 ## GNU General Public License for more details. |
2313 | 19 ## |
20 ## You should have received a copy of the GNU General Public License | |
7016 | 21 ## 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:
23220
diff
changeset
|
22 ## <https://www.gnu.org/licenses/>. |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
23 ## |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
24 ######################################################################## |
2268 | 25 |
3361 | 26 ## -*- texinfo -*- |
28237
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
27 ## @deftypefn {} {} dec2bin (@var{d}) |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
28 ## @deftypefnx {} {} dec2bin (@var{d}, @var{len}) |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
29 ## Return a string of ones and zeros representing the conversion of the integer |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
30 ## @var{d} to a binary number. |
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
31 ## |
28237
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
32 ## If @var{d} is negative, return the two's complement binary value of @var{d}. |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
33 ## If @var{d} is a matrix or cell array, return a string matrix with one row |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
34 ## for each element in @var{d}, padded with leading zeros to the width of the |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
35 ## largest value. |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
36 ## |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
37 ## The optional second argument, @var{len}, specifies the minimum number of |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
38 ## digits in the result. |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
39 ## |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
40 ## Examples: |
3426 | 41 ## |
3361 | 42 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
43 ## @group |
3361 | 44 ## dec2bin (14) |
45 ## @result{} "1110" | |
28236
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
46 ## |
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
47 ## dec2bin (-14) |
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
48 ## @result{} "11110010" |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
49 ## @end group |
3361 | 50 ## @end example |
3789 | 51 ## |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
52 ## @seealso{bin2dec, dec2base, dec2hex} |
3361 | 53 ## @end deftypefn |
2268 | 54 |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
55 function b = dec2bin (d, len) |
2268 | 56 |
28237
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
57 if (nargin == 0 || nargin > 2) |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
58 print_usage (); |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
59 endif |
28236
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
60 |
28237
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
61 if (iscell (d)) |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
62 d = cell2mat (d); |
28236
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
63 endif |
28237
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
64 ## Create column vector for algorithm (output is always col. vector anyways) |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
65 d = d(:); |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
66 |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
67 lt_zero_idx = (d < 0); |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
68 if (any (lt_zero_idx)) |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
69 if (any (d(lt_zero_idx) < intmin ("int64"))) |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
70 error ('dec2bin: negative inputs cannot be less than intmin ("int64")'); |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
71 elseif (any (d(lt_zero_idx) < intmin ("int32"))) |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
72 d(lt_zero_idx) += double (intmax ("uint64")) + 1; |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
73 elseif (any (d < intmin ("int16"))) |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
74 d(lt_zero_idx) += double (intmax ("uint32")) + 1; |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
75 elseif (any (d < intmin ("int8"))) |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
76 d(lt_zero_idx) += double (intmax ("uint16"))+ 1; |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
77 else |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
78 d(lt_zero_idx) += double (intmax ("uint8")) + 1; |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
79 endif |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
80 endif |
28236
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
81 |
4492 | 82 if (nargin == 1) |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
83 b = dec2base (d, 2); |
28237
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
84 else |
11172
7e8ce65f73cf
Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
85 b = dec2base (d, 2, len); |
2268 | 86 endif |
87 | |
88 endfunction | |
7411 | 89 |
13167
f7cb824dc8c0
Allow cellstr inputs for dec2* conversion functions.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
90 |
28236
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
91 %!assert (dec2bin (3), "11") |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
92 %!assert (dec2bin (14), "1110") |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
93 %!assert (dec2bin (14, 6), "001110") |
28236
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
94 %!assert (dec2bin ([1, 2; 3, 4]), ["001"; "011"; "010"; "100"]) |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
95 %!assert (dec2bin ({1, 2; 3, 4}), ["001"; "011"; "010"; "100"]) |
28236
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
96 %!assert (dec2bin ({1, 2; 3, 4}, 4), ["0001"; "0011"; "0010"; "0100"]) |
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
97 |
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
98 ## Test negative inputs |
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
99 %!assert (dec2bin (-3), "11111101") |
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
100 %!assert (dec2bin (-3, 3), "11111101") |
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
101 %!assert (dec2bin (-3, 9), "011111101") |
28237
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
102 %!assert (dec2bin (-2^7 -1), "1111111101111111") |
28236
5bb1c0cbb27e
dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents:
27985
diff
changeset
|
103 %!assert (dec2bin (-2^15 -1), "11111111111111110111111111111111") |
28237
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
104 ## The expected value is correct, but not what Octave generates because |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
105 ## floating point integer precision is 2^53. Matlab gets this right. |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
106 %!xtest |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
107 %! assert (dec2bin (-2^31 -1), |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
108 %! "1111111111111111111111111111111101111111111111111111111111111111"); |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
109 %!assert (dec2bin (-2^63), |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
110 %! "1000000000000000000000000000000000000000000000000000000000000000") |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
111 ## These tests also don't work because of floating point precision. |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
112 %!xtest |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
113 %! assert (dec2bin (int64 (-2^63)), |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
114 %! "1000000000000000000000000000000000000000000000000000000000000000"); |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
115 %!xtest |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
116 %! assert (dec2bin (int64 (-2^63) -1), |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
117 %! "1000000000000000000000000000000000000000000000000000000000000000"); |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
118 %!xtest |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
119 %! assert (dec2bin (int64 (-2^63) +1), |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
120 %! "1000000000000000000000000000000000000000000000000000000000000001"); |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
121 %!assert (dec2bin ([-1, -2; -3, -4]), |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
122 %! ["11111111"; "11111101"; "11111110"; "11111100"]) |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
123 %!assert (dec2bin ([1, 2; 3, -4]), |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
124 %! ["00000001"; "00000011"; "00000010"; "11111100"]) |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
125 %!assert (dec2bin ({1, 2; 3, -4}), |
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
126 %! ["00000001"; "00000011"; "00000010"; "11111100"]) |
7411 | 127 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
128 ## Test input validation |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
129 %!error dec2bin () |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
130 %!error dec2bin (1, 2, 3) |
28237
ac3a078e688f
dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents:
28236
diff
changeset
|
131 %!error <negative inputs> dec2bin (2 * double (intmin ("int64"))) |