Mercurial > octave
view scripts/general/bitset.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 | 74089676bd9d |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2004-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{C} =} bitset (@var{A}, @var{n}) ## @deftypefnx {} {@var{C} =} bitset (@var{A}, @var{n}, @var{val}) ## Set or reset bit(s) at position @var{n} of the unsigned integers in @var{A}. ## ## The least significant bit is @var{n} = 1. @w{@var{val} = 0} resets bits and ## @w{@var{val} = 1} sets bits. If no @var{val} is specified it defaults to ## 1 (set bit). All inputs must be the same size or scalars. ## ## Example 1: Set multiple bits ## ## @example ## @group ## x = bitset (1, 3:5) ## @result{} x = ## ## 5 9 17 ## ## dec2bin (x) ## @result{} ## 00101 ## 01001 ## 10001 ## @end group ## @end example ## ## Example 2: Reset and set bits ## ## @example ## @group ## x = bitset ([15 14], 1, [0 1]) ## @result{} x = ## ## 14 15 ## @end group ## @end example ## @seealso{bitand, bitor, bitxor, bitget, bitcmp, bitshift, intmax, flintmax} ## @end deftypefn function C = bitset (A, n, val = true) if (nargin < 2) print_usage (); endif if (any (A(:) < 0)) error ("bitset: A must be >= 0"); endif [size_err, A, n, val] = common_size (A, n, val); if (size_err) error ("bitset: A, N, and VAL must be the same size or scalar"); endif ## Special case of empty input if (isempty (A)) C = []; return; endif sz = size (A); cl = class (A); if (isfloat (A) && isreal (A)) Bmax = flintmax (cl); Amax = ceil (log2 (Bmax)); elseif (isinteger (A)) Bmax = intmax (cl); Amax = ceil (log2 (Bmax)); else error ("bitset: invalid class %s", cl); endif if (any ((n < 1)(:)) || any ((n > Amax)(:))) error ("bitset: N must be in the range [1,%d]", Amax); endif mask = bitshift (cast (1, cl), uint8 (n) - uint8 (1)); on = logical (val); off = ! on; if (isscalar (mask)) onmask = mask; offmask = mask; else onmask = mask(on); offmask = mask(off); endif C = zeros (sz, cl); C(on) = bitor (A(on), onmask); C(off) = bitand (A(off), bitcmp (offmask)); endfunction %!test %! assert (bitset ([0, 10], [3, 3]), [4, 14]); %! assert (bitset (single ([0, 10]), [3, 3]), single ([4, 14])); %! pfx = {"", "u"}; %! for i = 1:2 %! for prec = [8, 16, 32, 64] %! fcn = str2func (sprintf ("%sint%d", pfx{i}, prec)); %! assert (bitset (fcn ([0, 10]), [3, 3]), fcn ([4, 14])); %! endfor %! endfor %!assert (bitset ([], 1), []) %!assert <*36458> (bitset (uint8 ([1, 2;3 4]), 1, [0 1; 0 1]), %! uint8 ([0, 3; 2 5])) %!assert (bitset (1:5, 1), [1, 3, 3, 5, 5]) %!assert (bitset (1:5, 1, [1, 1, 1, 1, 1]), [1, 3, 3, 5, 5]) %!assert <*54110> (bitset (1:5, 1, 1), [1, 3, 3, 5, 5]) %!assert (bitset (1:5, 1, [1, 1, 1, 1, 0]), [1, 3, 3, 5, 4]) ## Test input validation %!error <Invalid call> bitset () %!error <Invalid call> bitset (1) %!error <A must be .= 0> bitset (-1, 2) %!error <must be the same size or scalar> bitset (1, [1 2], [1 2 3]) %!error <must be the same size or scalar> bitset ([1 2], [1 2 3]) %!error <invalid class char> bitset ("1", 2) %!error <N must be in the range \[1,53\]> bitset (0, 0) %!error <N must be in the range \[1,53\]> bitset (0, 55) %!error <N must be in the range \[1,24\]> bitset (single (0), 0) %!error <N must be in the range \[1,24\]> bitset (single (0), 26) %!error <N must be in the range \[1,8\]> bitset (uint8 (0), 0) %!error <N must be in the range \[1,8\]> bitset (uint8 (0), 9) %!error <N must be in the range \[1,7\]> bitset (int8 (0), 9) %!error <N must be in the range \[1,15\]> bitset (int16 (0), 17) %!error <N must be in the range \[1,16\]> bitset (uint16 (0), 17) %!error <N must be in the range \[1,31\]> bitset (int32 (0), 33) %!error <N must be in the range \[1,32\]> bitset (uint32 (0), 33) %!error <N must be in the range \[1,63\]> bitset (int64 (0), 65) %!error <N must be in the range \[1,64\]> bitset (uint64 (0), 65)