Mercurial > octave-antonio
view scripts/general/bitcmp.m @ 20158:7503499a252b stable
doc: Update docstrings to have one sentence summary as first line.
Update scripts in audio, elfun, general, geometry, and image directories.
* scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m,
scripts/audio/@audiorecorder/subsasgn.m,
scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m,
scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m,
scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m,
scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m,
scripts/general/accumarray.m, scripts/general/accumdim.m,
scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m,
scripts/general/blkdiag.m, scripts/general/cart2pol.m,
scripts/general/cart2sph.m, scripts/general/cell2mat.m,
scripts/general/celldisp.m, scripts/general/chop.m,
scripts/general/circshift.m, scripts/general/common_size.m,
scripts/general/cplxpair.m, scripts/general/cumtrapz.m,
scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m,
scripts/general/display.m, scripts/general/divergence.m,
scripts/general/fieldnames.m, scripts/general/flip.m,
scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m,
scripts/general/gradient.m, scripts/general/interp3.m,
scripts/general/interpft.m, scripts/general/interpn.m,
scripts/general/loadobj.m, scripts/general/logspace.m,
scripts/general/methods.m, scripts/general/nargchk.m,
scripts/general/narginchk.m, scripts/general/nargoutchk.m,
scripts/general/nextpow2.m, scripts/general/nthargout.m,
scripts/general/num2str.m, scripts/general/pol2cart.m,
scripts/general/polyarea.m, scripts/general/postpad.m,
scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m,
scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m,
scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m,
scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m,
scripts/general/shiftdim.m, scripts/general/sortrows.m,
scripts/general/sph2cart.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/trapz.m,
scripts/general/triplequad.m, scripts/geometry/delaunayn.m,
scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m,
scripts/geometry/rectint.m, scripts/geometry/tsearchn.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/help/__unimplemented__.m, scripts/help/doc.m,
scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m,
scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m,
scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m,
scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m,
scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m,
scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m,
scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m,
scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m,
scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m,
scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m,
scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m,
scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m,
scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m,
scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m,
scripts/image/white.m, scripts/image/winter.m:
Update docstrings to have one sentence summary as first line.
Re-structure to have line lengths <= 80 chars.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 09:36:20 -0700 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
## Copyright (C) 2004-2015 David Bateman ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} bitcmp (@var{A}, @var{k}) ## Return the @var{k}-bit complement of integers in @var{A}. ## ## If @var{k} is omitted @code{k = log2 (bitmax) + 1} is assumed. ## ## @example ## @group ## bitcmp (7,4) ## @result{} 8 ## dec2bin (11) ## @result{} 1011 ## dec2bin (bitcmp (11, 6)) ## @result{} 110100 ## @end group ## @end example ## ## @seealso{bitand, bitor, bitxor, bitset, bitget, bitcmp, bitshift, bitmax} ## @end deftypefn ## Liberally based on the version by Kai Habel from octave-forge function C = bitcmp (A, k) if (nargin < 1 || nargin > 2) print_usage (); endif if (nargin == 2 && (! isscalar (k) || (floor (k) != k))) error ("bitcmp: K must be a scalar integer"); endif if (isa (A, "double")) bmax = bitmax; amax = ceil (log2 (bmax)); elseif (isa (A, "single")) bmax = bitmax ("single"); amax = ceil (log2 (bmax)); elseif (isinteger (A)) amax = sizeof (ones (1, class (A))) * 8; bmax = bitpack (true (amax, 1), class (A)); else error ("bitcmp: invalid class %s", class (A)); endif if (nargin == 1 || k == amax) C = bitxor (A, bmax); else m = double (k); if (any (m < 1) || any (m > amax)) error ("bitcmp: K must be in the range [1,%d]", amax); endif mask = bitshift (bmax, k - amax); C = bitxor (bitand (A, mask), mask); endif endfunction %!test %! Amax = 53; %! Bmax = bitmax; %! A = bitshift (Bmax,-2); %! assert (bitcmp (A,Amax),bitor (bitshift (1,Amax-1), bitshift (1,Amax-2))); %! assert (bitcmp (A,Amax-1), bitshift (1,Amax-2)); %! assert (bitcmp (A,Amax-2), 0); %!test %! Amax = 24; %! Bmax = bitmax ("single"); %! A = bitshift (Bmax,-2); %! assert (bitcmp (A,Amax),bitor (bitshift (single (1),Amax-1), bitshift (single (1),Amax-2))); %! assert (bitcmp (A,Amax-1), bitshift (single (1),Amax-2)); %! assert (bitcmp (A,Amax-2), single (0)); %!test %! Amax = 8; %! Bmax = intmax ("uint8"); %! A = bitshift (Bmax,-2); %! assert (bitcmp (A,Amax),bitor (bitshift (uint8 (1),Amax-1), bitshift (uint8 (1),Amax-2))); %! assert (bitcmp (A,Amax-1), bitshift (uint8 (1),Amax-2)); %! assert (bitcmp (A,Amax-2), uint8 (0)); %!test %! Amax = 16; %! Bmax = intmax ("uint16"); %! A = bitshift (Bmax,-2); %! assert (bitcmp (A,Amax),bitor (bitshift (uint16 (1),Amax-1), bitshift (uint16 (1),Amax-2))); %! assert (bitcmp (A,Amax-1), bitshift (uint16 (1),Amax-2)); %! assert (bitcmp (A,Amax-2), uint16 (0)); %!test %! Amax = 32; %! Bmax = intmax ("uint32"); %! A = bitshift (Bmax,-2); %! assert (bitcmp (A,Amax),bitor (bitshift (uint32 (1),Amax-1), bitshift (uint32 (1),Amax-2))); %! assert (bitcmp (A,Amax-1), bitshift (uint32 (1),Amax-2)); %! assert (bitcmp (A,Amax-2), uint32 (0)); %!test %! Amax = 64; %! Bmax = intmax ("uint64"); %! A = bitshift (Bmax,-2); %! assert (bitcmp (A,Amax),bitor (bitshift (uint64 (1),Amax-1), bitshift (uint64 (1),Amax-2))); %! assert (bitcmp (A,Amax-1), bitshift (uint64 (1),Amax-2)); %! assert (bitcmp (A,Amax-2), uint64 (0)); ## Do not forget signed integers %!assert (bitcmp (int8 (127)), int8 (-128)) # [1 1 1 1 1 1 1 0] %!assert (bitcmp (int8 (1)), int8 (-2)) # [1 0 0 0 0 0 0 0] %!assert (bitcmp (int8 (0)), int8 (-1)) # [0 0 0 0 0 0 0 0] %!assert (bitcmp (int8 (8)), int8 (-9)) # [0 0 0 1 0 0 0 0]