Mercurial > octave
view scripts/strings/dec2hex.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 796f54d4ddbf |
children | dd6b37f67db2 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 1996-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{hstr} =} dec2hex (@var{d}) ## @deftypefnx {} {@var{hstr} =} dec2hex (@var{d}, @var{len}) ## Return a string representing the conversion of the integer @var{d} to a ## hexadecimal (base16) number. ## ## If @var{d} is negative, return the hexadecimal equivalent of the two's ## complement binary value of @var{d}. ## If @var{d} is a matrix or cell array, return a string matrix with one row ## for each element in @var{d}, padded with leading zeros to the width of the ## largest value. ## ## The optional second argument, @var{len}, specifies the minimum number of ## digits in the result. ## ## Examples: ## ## @example ## @group ## dec2hex (2748) ## @result{} "ABC" ## ## dec2hex (-2) ## @result{} "FE" ## @end group ## @end example ## ## @seealso{hex2dec, dec2base, dec2bin} ## @end deftypefn function hstr = dec2hex (d, len) if (nargin == 0) print_usage (); endif if (iscell (d)) d = cell2mat (d); endif ## Create column vector for algorithm (output is always col. vector anyways) d = d(:); lt_zero_idx = (d < 0); if (any (lt_zero_idx)) ## FIXME: Need an algorithm that works with larger values such as int64. if (any (d(lt_zero_idx) < -2^52)) error ("dec2hex: negative inputs cannot be less than -flintmax () / 2"); elseif (any (d(lt_zero_idx) < intmin ("int32"))) d(lt_zero_idx) += flintmax (); elseif (any (d < intmin ("int16"))) d(lt_zero_idx) += double (intmax ("uint32")) + 1; elseif (any (d < intmin ("int8"))) d(lt_zero_idx) += double (intmax ("uint16"))+ 1; else d(lt_zero_idx) += double (intmax ("uint8")) + 1; endif endif if (nargin == 1) hstr = dec2base (d, 16); else hstr = dec2base (d, 16, len); endif endfunction %!assert (dec2hex (2748), "ABC") %!assert (dec2hex (2748, 5), "00ABC") %!assert (dec2hex ([2748, 2746]), ["ABC"; "ABA"]) %!assert (dec2hex ({2748, 2746}), ["ABC"; "ABA"]) %!assert (dec2hex ({2748, 2746}, 4), ["0ABC"; "0ABA"]) ## Test negative inputs %!assert (dec2hex (-3), "FD") %!assert (dec2hex (-3, 1), "FD") %!assert (dec2hex (-3, 3), "0FD") %!assert (dec2hex (-2^7 -1), "FF7F") %!assert (dec2hex (-2^15 -1), "FFFF7FFF") ## FIXME: Matlab returns longer string that begins with 'F' %!assert (dec2hex (-2^31 -1), "1FFFFF7FFFFFFF") ## FIXME: Matlab returns longer string that begins with 'FFF' %!assert (dec2hex (-2^52), "10000000000000") ## FIXME: Uncomment when support for int64 is added %!#assert (dec2hex (-2^63), %! "1000000000000000000000000000000000000000000000000000000000000000") %!#test %! assert (dec2hex (int64 (-2^63)), %! "1000000000000000000000000000000000000000000000000000000000000000"); %!#test %! assert (dec2hex (int64 (-2^63) -1), %! "1000000000000000000000000000000000000000000000000000000000000000"); %!#test %! assert (dec2hex (int64 (-2^63) +1), %! "1000000000000000000000000000000000000000000000000000000000000001"); %!assert (dec2hex ([-1, -2; -3, -4]), ["FF"; "FD"; "FE"; "FC"]) %!assert (dec2hex ([1, 2; 3, -4]), ["01"; "03"; "02"; "FC"]) %!assert (dec2hex ({1, 2; 3, -4}), ["01"; "03"; "02"; "FC"]) ## Test input validation %!error <Invalid call> dec2hex () %!error <negative inputs cannot be less than> dec2hex (- flintmax ())