octave: scripts/general/bitcmp.m annotate

annotate scripts/general/bitcmp.m @ 21758:ffad2baa90f7

maint: Use newlines to make code more readable.

author	Rik <rik@octave.org>
date	Fri, 20 May 2016 15:46:45 -0700
parents	516bb87ea72e
children	bac0d6f07a3e

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19252 diff changeset	1 ## Copyright (C) 2004-2015 David Bateman
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	2 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6515 diff changeset	3 ## This file is part of Octave.
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	4 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6515 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6515 diff changeset	6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6515 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6515 diff changeset	8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6515 diff changeset	9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6515 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6515 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6515 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6515 diff changeset	13 ## General Public License for more details.
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	14 ##
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	15 ## 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: 6515 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6515 diff changeset	17 ## <http://www.gnu.org/licenses/>.
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	18
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20486 diff changeset	20 ## @deftypefn {} {} bitcmp (@var{A}, @var{k})
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	21 ## Return the @var{k}-bit complement of integers in @var{A}.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	22 ##
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20158 diff changeset	23 ## If @var{k} is omitted @code{k = log2 (flintmax) + 1} is assumed.
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	24 ##
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	25 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	26 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	27 ## bitcmp (7,4)
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	28 ## @result{} 8
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	29 ## dec2bin (11)
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	30 ## @result{} 1011
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	31 ## dec2bin (bitcmp (11, 6))
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	32 ## @result{} 110100
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	33 ## @end group
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	34 ## @end example
19252 79d4783a9978 bitcmp: fix bitwise complement for signed integers. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	35 ##
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20158 diff changeset	36 ## @seealso{bitand, bitor, bitxor, bitset, bitget, bitcmp, bitshift, flintmax}
5053 c08cb1098afc [project @ 2004-10-19 23:10:54 by jwe] jwe parents: 4950 diff changeset	37 ## @end deftypefn
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	38
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	39 ## Liberally based on the version by Kai Habel from octave-forge
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	40
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	41 function C = bitcmp (A, k)
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	42
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	43 if (nargin < 1 \|\| nargin > 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	44 print_usage ();
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	45 endif
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	46
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	47 if (nargin == 2 && (! isscalar (k) \|\| (floor (k) != k)))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 11469 diff changeset	48 error ("bitcmp: K must be a scalar integer");
6515 fc527bc3ece1 [project @ 2007-04-11 14:20:39 by jwe] jwe parents: 6046 diff changeset	49 endif
fc527bc3ece1 [project @ 2007-04-11 14:20:39 by jwe] jwe parents: 6046 diff changeset	50
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	51 if (isa (A, "double"))
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20158 diff changeset	52 bmax = flintmax - 1;
7333 66dfb0abd3d3 [project @ 2007-12-21 21:22:43 by jwe] jwe parents: 7332 diff changeset	53 amax = ceil (log2 (bmax));
17392 e09cd91168d1 Support arguments of class single in bit manipulation functions (bug #34502) Mike Miller <mtmiller@ieee.org> parents: 14363 diff changeset	54 elseif (isa (A, "single"))
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20158 diff changeset	55 bmax = flintmax ("single") - 1;
17392 e09cd91168d1 Support arguments of class single in bit manipulation functions (bug #34502) Mike Miller <mtmiller@ieee.org> parents: 14363 diff changeset	56 amax = ceil (log2 (bmax));
19252 79d4783a9978 bitcmp: fix bitwise complement for signed integers. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	57 elseif (isinteger (A))
79d4783a9978 bitcmp: fix bitwise complement for signed integers. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	58 amax = sizeof (ones (1, class (A))) * 8;
79d4783a9978 bitcmp: fix bitwise complement for signed integers. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	59 bmax = bitpack (true (amax, 1), class (A));
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	60 else
19252 79d4783a9978 bitcmp: fix bitwise complement for signed integers. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	61 error ("bitcmp: invalid class %s", class (A));
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	62 endif
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	63
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	64 if (nargin == 1 \|\| k == amax)
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	65 C = bitxor (A, bmax);
6515 fc527bc3ece1 [project @ 2007-04-11 14:20:39 by jwe] jwe parents: 6046 diff changeset	66 else
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	67 m = double (k);
6515 fc527bc3ece1 [project @ 2007-04-11 14:20:39 by jwe] jwe parents: 6046 diff changeset	68 if (any (m < 1) \|\| any (m > amax))
12480 139f993936af Uppercase variables in script error strings. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	69 error ("bitcmp: K must be in the range [1,%d]", amax);
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	70 endif
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	71 mask = bitshift (bmax, k - amax);
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	72 C = bitxor (bitand (A, mask), mask);
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	73 endif
21758 ffad2baa90f7 maint: Use newlines to make code more readable. Rik <rik@octave.org> parents: 20852 diff changeset	74
6515 fc527bc3ece1 [project @ 2007-04-11 14:20:39 by jwe] jwe parents: 6046 diff changeset	75 endfunction
4916 c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe] jwe parents: diff changeset	76
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	77
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	78 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	79 %! Amax = 53;
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20158 diff changeset	80 %! Bmax = flintmax - 1;
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	81 %! A = bitshift (Bmax,-2);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	82 %! assert (bitcmp (A,Amax),bitor (bitshift (1,Amax-1), bitshift (1,Amax-2)));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	83 %! assert (bitcmp (A,Amax-1), bitshift (1,Amax-2));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	84 %! assert (bitcmp (A,Amax-2), 0);
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	85 %!test
17392 e09cd91168d1 Support arguments of class single in bit manipulation functions (bug #34502) Mike Miller <mtmiller@ieee.org> parents: 14363 diff changeset	86 %! Amax = 24;
20486 4bb41929286b Deprecate bitmax. Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 20158 diff changeset	87 %! Bmax = flintmax ("single") - 1;
17392 e09cd91168d1 Support arguments of class single in bit manipulation functions (bug #34502) Mike Miller <mtmiller@ieee.org> parents: 14363 diff changeset	88 %! A = bitshift (Bmax,-2);
e09cd91168d1 Support arguments of class single in bit manipulation functions (bug #34502) Mike Miller <mtmiller@ieee.org> parents: 14363 diff changeset	89 %! assert (bitcmp (A,Amax),bitor (bitshift (single (1),Amax-1), bitshift (single (1),Amax-2)));
e09cd91168d1 Support arguments of class single in bit manipulation functions (bug #34502) Mike Miller <mtmiller@ieee.org> parents: 14363 diff changeset	90 %! assert (bitcmp (A,Amax-1), bitshift (single (1),Amax-2));
e09cd91168d1 Support arguments of class single in bit manipulation functions (bug #34502) Mike Miller <mtmiller@ieee.org> parents: 14363 diff changeset	91 %! assert (bitcmp (A,Amax-2), single (0));
e09cd91168d1 Support arguments of class single in bit manipulation functions (bug #34502) Mike Miller <mtmiller@ieee.org> parents: 14363 diff changeset	92 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	93 %! Amax = 8;
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	94 %! Bmax = intmax ("uint8");
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	95 %! A = bitshift (Bmax,-2);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	96 %! assert (bitcmp (A,Amax),bitor (bitshift (uint8 (1),Amax-1), bitshift (uint8 (1),Amax-2)));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	97 %! assert (bitcmp (A,Amax-1), bitshift (uint8 (1),Amax-2));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	98 %! assert (bitcmp (A,Amax-2), uint8 (0));
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	99 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	100 %! Amax = 16;
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	101 %! Bmax = intmax ("uint16");
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	102 %! A = bitshift (Bmax,-2);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	103 %! assert (bitcmp (A,Amax),bitor (bitshift (uint16 (1),Amax-1), bitshift (uint16 (1),Amax-2)));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	104 %! assert (bitcmp (A,Amax-1), bitshift (uint16 (1),Amax-2));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	105 %! assert (bitcmp (A,Amax-2), uint16 (0));
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	106 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	107 %! Amax = 32;
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	108 %! Bmax = intmax ("uint32");
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	109 %! A = bitshift (Bmax,-2);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	110 %! assert (bitcmp (A,Amax),bitor (bitshift (uint32 (1),Amax-1), bitshift (uint32 (1),Amax-2)));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	111 %! assert (bitcmp (A,Amax-1), bitshift (uint32 (1),Amax-2));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	112 %! assert (bitcmp (A,Amax-2), uint32 (0));
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	113 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	114 %! Amax = 64;
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	115 %! Bmax = intmax ("uint64");
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	116 %! A = bitshift (Bmax,-2);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	117 %! assert (bitcmp (A,Amax),bitor (bitshift (uint64 (1),Amax-1), bitshift (uint64 (1),Amax-2)));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	118 %! assert (bitcmp (A,Amax-1), bitshift (uint64 (1),Amax-2));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	119 %! assert (bitcmp (A,Amax-2), uint64 (0));
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	120
19252 79d4783a9978 bitcmp: fix bitwise complement for signed integers. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	121 ## Do not forget signed integers
79d4783a9978 bitcmp: fix bitwise complement for signed integers. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	122 %!assert (bitcmp (int8 (127)), int8 (-128)) # [1 1 1 1 1 1 1 0]
79d4783a9978 bitcmp: fix bitwise complement for signed integers. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	123 %!assert (bitcmp (int8 (1)), int8 (-2)) # [1 0 0 0 0 0 0 0]
79d4783a9978 bitcmp: fix bitwise complement for signed integers. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	124 %!assert (bitcmp (int8 (0)), int8 (-1)) # [0 0 0 0 0 0 0 0]
79d4783a9978 bitcmp: fix bitwise complement for signed integers. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	125 %!assert (bitcmp (int8 (8)), int8 (-9)) # [0 0 0 1 0 0 0 0]
79d4783a9978 bitcmp: fix bitwise complement for signed integers. Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	126

Mercurial > octave

annotate scripts/general/bitcmp.m @ 21758:ffad2baa90f7