annotate scripts/strings/dec2bin.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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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: 2355
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{bstr} =} dec2bin (@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{bstr} =} dec2bin (@var{d}, @var{len})
28237
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
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3361
diff changeset
41 ##
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
42 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
43 ## @group
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
44 ## dec2bin (14)
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
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
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
50 ## @end example
3789
2a257be5e488 [project @ 2001-02-09 04:12:30 by jwe]
jwe
parents: 3426
diff changeset
51 ##
29197
1a3cb2e1644a dec2bin.m: Add docstring note about fractional input incompatibility (bug #59719).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 28886
diff changeset
52 ## Programming Notes: The largest negative value that can be converted into
28241
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
53 ## two's complement is @code{- (flintmax () / 2)}.
4492
819e3c246702 [project @ 2003-08-29 17:09:38 by jwe]
jwe
parents: 3791
diff changeset
54 ##
29197
1a3cb2e1644a dec2bin.m: Add docstring note about fractional input incompatibility (bug #59719).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 28886
diff changeset
55 ## Known @sc{matlab} Incompatibility: @sc{matlab}'s @code{dec2bin} allows
1a3cb2e1644a dec2bin.m: Add docstring note about fractional input incompatibility (bug #59719).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 28886
diff changeset
56 ## non-integer values for @var{d}, truncating the value using the equivalent
1a3cb2e1644a dec2bin.m: Add docstring note about fractional input incompatibility (bug #59719).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 28886
diff changeset
57 ## of @code{fix (@var{d})} for positive values, but, as of R2020b and in
1a3cb2e1644a dec2bin.m: Add docstring note about fractional input incompatibility (bug #59719).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 28886
diff changeset
58 ## conflict with published documentation, appears to use
1a3cb2e1644a dec2bin.m: Add docstring note about fractional input incompatibility (bug #59719).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 28886
diff changeset
59 ## @code{round (@var{d})} for negative values. To be consistent with
1a3cb2e1644a dec2bin.m: Add docstring note about fractional input incompatibility (bug #59719).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 28886
diff changeset
60 ## @code{dec2hex} and @code{dec2base}, Octave produces an error for non-integer
1a3cb2e1644a dec2bin.m: Add docstring note about fractional input incompatibility (bug #59719).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 28886
diff changeset
61 ## valued inputs for @var{d}. Users wanting compatible code for non-integer
1a3cb2e1644a dec2bin.m: Add docstring note about fractional input incompatibility (bug #59719).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 28886
diff changeset
62 ## valued inputs should make use of @code{fix} or @code{round} as appropriate.
11172
7e8ce65f73cf Overhaul functions used to convert between number bases.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
63 ## @seealso{bin2dec, dec2base, dec2hex}
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2355
diff changeset
64 ## @end deftypefn
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
65
30875
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents: 30564
diff changeset
66 function bstr = dec2bin (d, len)
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
67
28789
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files.
Rik <rik@octave.org>
parents: 28693
diff changeset
68 if (nargin == 0)
28237
ac3a078e688f dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents: 28236
diff changeset
69 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
70 endif
28236
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 27985
diff changeset
71
28237
ac3a078e688f dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents: 28236
diff changeset
72 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
73 d = cell2mat (d);
28236
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 27985
diff changeset
74 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
75 ## 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
76 d = d(:);
28693
2bb050267d74 maint: Remove trailing spaces from code base.
Rik <rik@octave.org>
parents: 28241
diff changeset
77
28237
ac3a078e688f dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents: 28236
diff changeset
78 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
79 if (any (lt_zero_idx))
28241
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
80 ## FIXME: Need an algorithm that works with larger values such as int64.
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
81 if (any (d(lt_zero_idx) < -2^52))
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
82 error ("dec2bin: negative inputs cannot be less than -flintmax () / 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
83 elseif (any (d(lt_zero_idx) < intmin ("int32")))
28241
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
84 d(lt_zero_idx) += flintmax ();
28237
ac3a078e688f dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents: 28236
diff changeset
85 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
86 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
87 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
88 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
89 else
ac3a078e688f dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents: 28236
diff changeset
90 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
91 endif
ac3a078e688f dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents: 28236
diff changeset
92 endif
28236
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 27985
diff changeset
93
4492
819e3c246702 [project @ 2003-08-29 17:09:38 by jwe]
jwe
parents: 3791
diff changeset
94 if (nargin == 1)
30875
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents: 30564
diff changeset
95 bstr = 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
96 else
30875
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents: 30564
diff changeset
97 bstr = dec2base (d, 2, len);
2268
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
98 endif
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
99
ee5ec3133ed3 [project @ 1996-05-24 00:53:19 by jwe]
jwe
parents:
diff changeset
100 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
101
13167
f7cb824dc8c0 Allow cellstr inputs for dec2* conversion functions.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
102
28236
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 27985
diff changeset
103 %!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
104 %!assert (dec2bin (14), "1110")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
105 %!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
106 %!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
107 %!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
108 %!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
109
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 27985
diff changeset
110 ## Test negative inputs
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 27985
diff changeset
111 %!assert (dec2bin (-3), "11111101")
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 27985
diff changeset
112 %!assert (dec2bin (-3, 3), "11111101")
5bb1c0cbb27e dec2bin.m: Allow negative number inputs (bug #58147).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 27985
diff changeset
113 %!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
114 %!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
115 %!assert (dec2bin (-2^15 -1), "11111111111111110111111111111111")
28241
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
116 ## FIXME: Matlab generates a string that is 64 characters long
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
117 %!assert (dec2bin (-2^31 -1),
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
118 %! "11111111111111111111101111111111111111111111111111111")
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
119 %!assert (dec2bin (-2^52),
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
120 %! "10000000000000000000000000000000000000000000000000000")
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
121 ## FIXME: Uncomment when support for int64 is added
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
122 %!#assert (dec2bin (-2^63),
28237
ac3a078e688f dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents: 28236
diff changeset
123 %! "1000000000000000000000000000000000000000000000000000000000000000")
28241
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
124 %!#test
28237
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 (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
126 %! "1000000000000000000000000000000000000000000000000000000000000000");
28241
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
127 %!#test
28237
ac3a078e688f dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents: 28236
diff changeset
128 %! 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
129 %! "1000000000000000000000000000000000000000000000000000000000000000");
28241
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
130 %!#test
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 %! 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
132 %! "1000000000000000000000000000000000000000000000000000000000000001");
ac3a078e688f dec2bin.m: Reduce number of times search for negative numbers is done (bug #58147).
Rik <rik@octave.org>
parents: 28236
diff changeset
133 %!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
134 %! ["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
135 %!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
136 %! ["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
137 %!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
138 %! ["00000001"; "00000011"; "00000010"; "11111100"])
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
139
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
140 ## 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
141 %!error <Invalid call> dec2bin ()
28241
ef7bc64a604b dec2bin.m: Fix algorithm for numbers less than intmin ('int32') (bug #58147).
Rik <rik@octave.org>
parents: 28237
diff changeset
142 %!error <negative inputs cannot be less than> dec2bin (- flintmax ())