octave: scripts/strings/dec2bin.m annotate

annotate scripts/strings/dec2bin.m @ 28236:5bb1c0cbb27e

dec2bin.m: Allow negative number inputs (bug #58147). * dec2bin.m: Document that negative numbers are converted according to 2's complement convention. Add example to documentation of converting a negative number. Add algorithm to detect negative inputs and add the appropriate offset for 2's complement notation. Add BIST tests.

author	Nicholas R. Jankowski <jankowskin@asme.org>
date	Wed, 22 Apr 2020 15:53:51 -0700
parents	9f9ac219896d
children	ac3a078e688f

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 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	7 ##
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	8 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	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 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	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 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	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 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	19 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	20 ## 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	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 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	25
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 2355 diff changeset	26 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20164 diff changeset	27 ## @deftypefn {} {} dec2bin (@var{d}, @var{len})
28236 5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	28 ## Return a binary number corresponding to the integer @var{d} as a string of
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	29 ## ones and zeros. If @var{d} is negative, return the two's complement binary
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	30 ## value of @var{d}.
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	31 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	32 ## For example:
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3361 diff changeset	33 ##
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 2355 diff changeset	34 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	35 ## @group
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 2355 diff changeset	36 ## dec2bin (14)
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 2355 diff changeset	37 ## @result{} "1110"
28236 5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	38 ##
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	39 ## dec2bin (-14)
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	40 ## @result{} "11110010"
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	41 ## @end group
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 2355 diff changeset	42 ## @end example
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: 3426 diff changeset	43 ##
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	44 ## If @var{d} is a matrix or cell array, return a string matrix with one row
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	45 ## per element in @var{d}, padded with leading zeros to the width of the
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	46 ## largest value.
4492 819e3c246702 [project @ 2003-08-29 17:09:38 by jwe] jwe parents: 3791 diff changeset	47 ##
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	48 ## The optional second argument, @var{len}, specifies the minimum number of
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	49 ## digits in the result.
28236 5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	50 ##
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	51 ## @seealso{bin2dec, dec2base, dec2hex}
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 2355 diff changeset	52 ## @end deftypefn
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	53
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	54 function b = dec2bin (d, len)
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	55
28236 5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	56 ## dec2base does cell->mat conversion, this allows easier content comparison
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	57 if (iscell (d))
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	58 d = cell2mat (d);
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	59 endif
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	60
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	61 d = d(:); ## output is always a column vector, (:) simplifies value checks
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	62
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	63 if (any (d < intmin ("int64")))
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	64 error ("dec2bin: negative inputs cannot be less than intmin('int64')");
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	65 endif
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	66
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	67 if (any (d < 0))
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	68 if (any (d < intmin ("int64")))
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	69 error ("out of range");
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	70 elseif (any (d < intmin ("int32")))
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	71 d(d < 0) += double (intmax ("uint64")) + 1 ;
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	72 elseif (any (d < intmin ("int16")))
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	73 d(d < 0) += double (intmax ("uint32")) + 1;
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	74 elseif (any (d < intmin ("int8")))
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	75 d(d < 0) += double (intmax ("uint16"))+ 1;
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	76 else
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	77 d(d < 0) += double (intmax ("uint8")) +1;
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	78 endif
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	79 endif
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	80
4492 819e3c246702 [project @ 2003-08-29 17:09:38 by jwe] jwe parents: 3791 diff changeset	81 if (nargin == 1)
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	82 b = dec2base (d, 2);
4492 819e3c246702 [project @ 2003-08-29 17:09:38 by jwe] jwe parents: 3791 diff changeset	83 elseif (nargin == 2)
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	84 b = dec2base (d, 2, len);
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: 3426 diff changeset	85 else
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	86 print_usage ();
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	87 endif
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	88
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	89 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	90
13167 f7cb824dc8c0 Allow cellstr inputs for dec2* conversion functions. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	91
28236 5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	92 %!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	93 %!assert (dec2bin (14), "1110")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	94 %!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	95 %!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	96 %!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	97 %!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	98
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	99 ## Test negative inputs
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	100 %!assert (dec2bin (-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, 3), "11111101")
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	102 %!assert (dec2bin (-3, 9), "011111101")
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	103 %!assert (dec2bin (-129), "1111111101111111")
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	104 %!assert (dec2bin (-2^15 -1), "11111111111111110111111111111111")
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	105 %!assert (dec2bin (-2^31 -1), "1111111111111111111111111111111101111111111111111111111111111111")
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	106 %!assert (dec2bin (-2^63), "1000000000000000000000000000000000000000000000000000000000000000")
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	107 %!assert (dec2bin (-2^63-1), "1000000000000000000000000000000000000000000000000000000000000000")
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	108 %!assert (dec2bin ([-1, -2; -3, -4]), ["11111111"; "11111101"; "11111110"; "11111100"])
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	109 %!assert (dec2bin ([1, 2; 3, -4]), ["00000001"; "00000011"; "00000010"; "11111100"])
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	110 %!assert (dec2bin ({1, 2; 3, -4}), ["00000001"; "00000011"; "00000010"; "11111100"])
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	111
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	112 ## Test input validation
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	113 %!error dec2bin ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	114 %!error dec2bin (1, 2, 3)
28236 5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147). Nicholas R. Jankowski <jankowskin@asme.org> parents: 27985 diff changeset	115 %!error dec2bin (2 * double (intmin ("int64")))

Mercurial > octave

annotate scripts/strings/dec2bin.m @ 28236:5bb1c0cbb27e