octave: scripts/strings/dec2hex.m annotate

annotate scripts/strings/dec2hex.m @ 30564:796f54d4ddbf stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021. In all .txi and .texi files except gpl.txi and gpl.texi in the doc/liboctave and doc/interpreter directories, change the copyright to "Octave Project Developers", the same as used for other source files. Update copyright notices for 2022 (not done since 2019). For gpl.txi and gpl.texi, change the copyright notice to be "Free Software Foundation, Inc." and leave the date at 2007 only because this file only contains the text of the GPL, not anything created by the Octave Project Developers. Add Paul Thomas to contributors.in.

author	John W. Eaton <jwe@octave.org>
date	Tue, 28 Dec 2021 18:22:40 -0500
parents	7854d5752dd2
children	5d3faba0342e 96ad887ae4f8

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 --
28242 f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	27 ## @deftypefn {} {} dec2hex (@var{d})
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	28 ## @deftypefnx {} {} dec2hex (@var{d}, @var{len})
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
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	56 function h = 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
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	62 if (iscell (d))
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	63 d = cell2mat (d);
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	64 endif
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	65 ## Create column vector for algorithm (output is always col. vector anyways)
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	66 d = d(:);
28693 2bb050267d74 maint: Remove trailing spaces from code base. Rik <rik@octave.org> parents: 28242 diff changeset	67
28242 f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	68 lt_zero_idx = (d < 0);
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	69 if (any (lt_zero_idx))
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	70 ## FIXME: Need an algorithm that works with larger values such as int64.
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	71 if (any (d(lt_zero_idx) < -2^52))
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	72 error ("dec2hex: negative inputs cannot be less than -flintmax () / 2");
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	73 elseif (any (d(lt_zero_idx) < intmin ("int32")))
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	74 d(lt_zero_idx) += flintmax ();
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	75 elseif (any (d < intmin ("int16")))
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	76 d(lt_zero_idx) += double (intmax ("uint32")) + 1;
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	77 elseif (any (d < intmin ("int8")))
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	78 d(lt_zero_idx) += double (intmax ("uint16"))+ 1;
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	79 else
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	80 d(lt_zero_idx) += double (intmax ("uint8")) + 1;
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	81 endif
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	82 endif
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	83
4492 819e3c246702 [project @ 2003-08-29 17:09:38 by jwe] jwe parents: 3791 diff changeset	84 if (nargin == 1)
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	85 h = dec2base (d, 16);
28242 f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	86 else
11172 7e8ce65f73cf Overhaul functions used to convert between number bases. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	87 h = dec2base (d, 16, len);
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	88 endif
2325 b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe] jwe parents: 2314 diff changeset	89
2268 ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe] jwe parents: diff changeset	90 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	91
13167 f7cb824dc8c0 Allow cellstr inputs for dec2* conversion functions. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	92
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	93 %!assert (dec2hex (2748), "ABC")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	94 %!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	95 %!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	96 %!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	97 %!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	98
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	99 ## Test negative inputs
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	100 %!assert (dec2hex (-3), "FD")
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	101 %!assert (dec2hex (-3, 1), "FD")
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	102 %!assert (dec2hex (-3, 3), "0FD")
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	103 %!assert (dec2hex (-2^7 -1), "FF7F")
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	104 %!assert (dec2hex (-2^15 -1), "FFFF7FFF")
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	105 ## FIXME: Matlab returns longer string that begins with 'F'
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	106 %!assert (dec2hex (-2^31 -1), "1FFFFF7FFFFFFF")
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	107 ## FIXME: Matlab returns longer string that begins with 'FFF'
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	108 %!assert (dec2hex (-2^52), "10000000000000")
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	109 ## FIXME: Uncomment when support for int64 is added
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	110 %!#assert (dec2hex (-2^63),
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	111 %! "1000000000000000000000000000000000000000000000000000000000000000")
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	112 %!#test
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	113 %! assert (dec2hex (int64 (-2^63)),
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	114 %! "1000000000000000000000000000000000000000000000000000000000000000");
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	115 %!#test
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	116 %! assert (dec2hex (int64 (-2^63) -1),
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	117 %! "1000000000000000000000000000000000000000000000000000000000000000");
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	118 %!#test
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	119 %! assert (dec2hex (int64 (-2^63) +1),
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	120 %! "1000000000000000000000000000000000000000000000000000000000000001");
f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	121 %!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	122 %!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	123 %!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	124
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	125 ## 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	126 %!error <Invalid call> dec2hex ()
28242 f618edac2a29 dec2hex.m: Implement support for negative number inputs (bug #58147). Rik <rik@octave.org> parents: 27985 diff changeset	127 %!error <negative inputs cannot be less than> dec2hex (- flintmax ())

Mercurial > octave

annotate scripts/strings/dec2hex.m @ 30564:796f54d4ddbf stable