Mercurial > octave
view scripts/general/bitget.m @ 30893:e1788b1a315f
maint: Use "fcn" as preferred abbreviation for "function" in m-files.
* accumarray.m, accumdim.m, quadl.m, quadv.m, randi.m, structfun.m,
__is_function__.m, uigetfile.m, uimenu.m, uiputfile.m, doc_cache_create.m,
colorspace_conversion_input_check.m, imageIO.m, argnames.m, vectorize.m,
vectorize.m, normest1.m, inputname.m, nthargout.m, display_info_file.m,
decic.m, ode15i.m, ode15s.m, ode23.m, ode23s.m, ode45.m, odeset.m,
check_default_input.m, integrate_adaptive.m, ode_event_handler.m,
runge_kutta_23.m, runge_kutta_23s.m, runge_kutta_45_dorpri.m,
runge_kutta_interpolate.m, starting_stepsize.m, __all_opts__.m, fminbnd.m,
fminsearch.m, fminunc.m, fsolve.m, fzero.m, sqp.m, fplot.m, plotyy.m,
__bar__.m, __ezplot__.m, flat_entry.html, profexport.m, movfun.m, bicg.m,
bicgstab.m, cgs.m, eigs.m, gmres.m, pcg.m, __alltohandles__.m, __sprand__.m,
qmr.m, tfqmr.m, dump_demos.m:
Replace "func", "fun", "fn" in documentation and variable names with "fcn".
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 Apr 2022 18:14:56 -0700 |
parents | af6623656f53 |
children | 597f3ee61a48 |
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{b} =} bitget (@var{A}, @var{n}) ## Return the bit value at position(s) @var{n} of the unsigned integers in ## @var{A}. ## ## The least significant bit is @var{n} = 1. ## ## @example ## @group ## bitget (100, 8:-1:1) ## @result{} 0 1 1 0 0 1 0 0 ## @end group ## @end example ## @seealso{bitand, bitor, bitxor, bitset, bitcmp, bitshift, intmax, flintmax} ## @end deftypefn ## Liberally based of the version by Kai Habel from Octave Forge function b = bitget (A, n) if (nargin != 2) print_usage (); endif if (isa (A, "double")) Amax = ceil (log2 (flintmax)); _conv = @double; elseif (isa (A, "single")) Amax = ceil (log2 (flintmax ("single"))); _conv = @single; else if (isa (A, "uint8")) Amax = 8; _conv = @uint8; elseif (isa (A, "uint16")) Amax = 16; _conv = @uint16; elseif (isa (A, "uint32")) Amax = 32; _conv = @uint32; elseif (isa (A, "uint64")) Amax = 64; _conv = @uint64; elseif (isa (A, "int8")) Amax = 8; _conv = @int8; elseif (isa (A, "int16")) Amax = 16; _conv = @int16; elseif (isa (A, "int32")) Amax = 32; _conv = @int32; elseif (isa (A, "int64")) Amax = 64; _conv = @int64; else error ("bitget: invalid class %s", class (A)); endif endif m = double (n(:)); if (any (m < 1) || any (m > Amax)) error ("bitget: N must be in the range [1,%d]", Amax); endif b = bitand (A, bitshift (_conv (1), uint8 (n) - uint8 (1))) != _conv (0); endfunction %!test %! assert (bitget ([4, 14], [3, 3]), logical ([1, 1])); %! assert (bitget (single ([4, 14]), [3, 3]), logical ([1, 1])); %! pfx = {"", "u"}; %! for i = 1:2 %! for prec = [8, 16, 32, 64] %! fcn = str2func (sprintf ("%sint%d", pfx{i}, prec)); %! assert (bitget (fcn ([4, 14]), [3, 3]), logical ([1, 1])); %! endfor %! endfor ## Test input validation %!error <Invalid call> bitget () %!error <Invalid call> bitget (1) %!error <invalid class> bitget ("char", 1) %!error <N must be in the range \[1,53\]> bitget (0, 0) %!error <N must be in the range \[1,53\]> bitget (0, 55) %!error <N must be in the range \[1,24\]> bitget (single (0), 0) %!error <N must be in the range \[1,24\]> bitget (single (0), 26) %!error <N must be in the range \[1,8\]> bitget (int8 (0), 9) %!error <N must be in the range \[1,8\]> bitget (uint8 (0), 9) %!error <N must be in the range \[1,16\]> bitget (int16 (0), 17) %!error <N must be in the range \[1,16\]> bitget (uint16 (0), 17) %!error <N must be in the range \[1,32\]> bitget (int32 (0), 33) %!error <N must be in the range \[1,32\]> bitget (uint32 (0), 33) %!error <N must be in the range \[1,64\]> bitget (int64 (0), 65) %!error <N must be in the range \[1,64\]> bitget (uint64 (0), 65)