octave: scripts/strings/dec2hex.m annotate

annotate scripts/strings/dec2hex.m @ 31239:dd6b37f67db2

Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) dec2bin.m: Accept negative inputs lower than -flintmax down to -2^63 Return 64-bit string in certain cases for Matlab compatibility Activate BISTs commented out earlier dec2hex.m: Remove repeated code and call dec2bin instead Accept negative inputs lower than -flintmax down to -2^63 Update and activate BISTs commented out earlier

author	Arun Giridhar <arungiridhar@gmail.com>
date	Sun, 25 Sep 2022 06:22:25 -0400
parents	5d3faba0342e
children	7018819318d1

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 ##
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	3 ## Copyright (C) 1996-2022 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: 3272 diff changeset	26 ## -- texinfo --
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	27 ## @deftypefn {} {@var{hstr} =} dec2hex (@var{d})
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	28 ## @deftypefnx {} {@var{hstr} =} dec2hex (@var{d}, @var{len})
28242 f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	29 ## Return a string representing the conversion of the integer @var{d} to a
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	30 ## hexadecimal (base16) number.
20164 df437a52bcaf doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	31 ##
29197 1a3cb2e1644a dec2bin.m: Add docstring note about fractional input incompatibility (bug #59719). Nicholas R. Jankowski <jankowskin@asme.org> parents: 28886 diff changeset	32 ## If @var{d} is negative, return the hexadecimal equivalent of the two's
1a3cb2e1644a dec2bin.m: Add docstring note about fractional input incompatibility (bug #59719). Nicholas R. Jankowski <jankowskin@asme.org> parents: 28886 diff changeset	33 ## complement binary value of @var{d}.
28242 f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	34 ## If @var{d} is a matrix or cell array, return a string matrix with one row
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	35 ## for each element in @var{d}, padded with leading zeros to the width of the
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	36 ## largest value.
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	37 ##
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	38 ## The optional second argument, @var{len}, specifies the minimum number of
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	39 ## digits in the result.
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	40 ##
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	41 ## Examples:
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3361 diff changeset	42 ##
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3272 diff changeset	43 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	44 ## @group
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3272 diff changeset	45 ## dec2hex (2748)
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: 3426 diff changeset	46 ## @result{} "ABC"
28242 f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	47 ##
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	48 ## dec2hex (-2)
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	49 ## @result{} "FE"
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	50 ## @end group
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3272 diff changeset	51 ## @end example
3789 2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe] jwe parents: 3426 diff changeset	52 ##
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	53 ## @seealso{hex2dec, dec2base, dec2bin}
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3272 diff changeset	54 ## @end deftypefn
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	55
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	56 function hstr = dec2hex (d, len)
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	57
28789 28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 28693 diff changeset	58 if (nargin == 0)
28242 f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	59 print_usage ();
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	60 endif
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	61
31239 dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	62 ## To avoid repeating a lot of code, including input validation, we call dec2bin.
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	63 if (nargin == 2)
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	64 d = dec2bin (d, len*4);
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	65 else
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	66 d = dec2bin (d);
28242 f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	67 endif
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	68
31239 dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	69 ## Left-pad with zeros to make the number of columns divisible by 4
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	70 n = mod (columns (d), 4);
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	71 if (n > 0)
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	72 d = [repmat("0", rows(d), 4-n), d];
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	73 endif
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	74
31239 dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	75 d -= "0"; # convert to numeric
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	76 d = d(:, 1:4:end) * 8 + d(:, 2:4:end) * 4 + d(:, 3:4:end) * 2 + d(:, 4:4:end);
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	77 ## Elements of d are now in the range 0 to 15
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	78
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	79 hstr = "0123456789ABCDEF"(d+1); # convert to char and return
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	80
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	81 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	82
13167 f7cb824dc8c0 Allow cellstr inputs for dec2* conversion functions. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	83
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	84 %!assert (dec2hex (2748), "ABC")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	85 %!assert (dec2hex (2748, 5), "00ABC")
28242 f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	86 %!assert (dec2hex ([2748, 2746]), ["ABC"; "ABA"])
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	87 %!assert (dec2hex ({2748, 2746}), ["ABC"; "ABA"])
28242 f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	88 %!assert (dec2hex ({2748, 2746}, 4), ["0ABC"; "0ABA"])
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	89
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	90 ## Test negative inputs
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	91 %!assert (dec2hex (-3), "FD")
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	92 %!assert (dec2hex (-3, 1), "FD")
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	93 %!assert (dec2hex (-3, 3), "0FD")
31239 dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	94 %!assert (dec2hex (-2^7 - 1), "FF7F")
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	95 %!assert (dec2hex (-2^15 - 1), "FFFF7FFF")
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	96 %!assert (dec2hex (-2^31 - 1), "FFFFFFFF7FFFFFFF")
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	97 %!assert (dec2hex (-2^52), "FFF0000000000000")
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	98 %!assert (dec2hex (-2^63), "8000000000000000")
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	99 %!assert (dec2hex (int64 (-2) ^ 63), "8000000000000000")
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	100 %!assert (dec2hex (int64 (-2) ^ 63 - 1), "8000000000000000")
dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	101 %!assert (dec2hex (int64 (-2) ^ 63 + 1), "8000000000000001")
28242 f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	102 %!assert (dec2hex ([-1, -2; -3, -4]), ["FF"; "FD"; "FE"; "FC"])
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	103 %!assert (dec2hex ([1, 2; 3, -4]), ["01"; "03"; "02"; "FC"])
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	104 %!assert (dec2hex ({1, 2; 3, -4}), ["01"; "03"; "02"; "FC"])
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	105
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	106 ## Test input validation
28886 d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 28789 diff changeset	107 %!error <Invalid call> dec2hex ()
31239 dd6b37f67db2 Accept negative inputs to -2^63 for dec2bin and dec2hex (bug #63089) Arun Giridhar <arungiridhar@gmail.com> parents: 30875 diff changeset	108

Mercurial > octave

annotate scripts/strings/dec2hex.m @ 31239:dd6b37f67db2