annotate scripts/general/bitcmp.m @ 5540:cda6a105ae9a before-ov-branch

[project @ 2005-11-17 05:47:13 by jwe]
author jwe
date Thu, 17 Nov 2005 05:47:13 +0000
parents 4c8a2e4e0717
children 2618a0750ae6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2004 David Bateman
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
2 ##
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
4 ## it under the terms of the GNU General Public License as published by
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
5 ## the Free Software Foundation; either version 2 of the License, or
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
6 ## (at your option) any later version.
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
7 ##
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful,
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
11 ## GNU General Public License for more details.
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
12 ##
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
14 ## along with this program; if not, write to the Free Software
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5053
diff changeset
15 ## Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5053
diff changeset
16 ## 02110-1301 USA
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
17
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
18 ## -*- texinfo -*-
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
19 ## @deftypefn {Function File} {@var{X} =} bitcmp (@var{a},@var{k})
4920
b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe]
jwe
parents: 4916
diff changeset
20 ## Return the @var{k}-bit complement of integers in @var{a}. If
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
21 ## @var{k} is omitted @code{k = log2(bitmax) + 1} is assumed.
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
22 ##
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
23 ## @example
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
24 ## bitcmp(7,4)
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
25 ## @result{} 8
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
26 ## dec2bin(11)
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
27 ## @result{} 1011
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
28 ## dec2bin(bitcmp(11))
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
29 ## @result{} 11111111111111111111111111110100
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
30 ## @end example
5053
c08cb1098afc [project @ 2004-10-19 23:10:54 by jwe]
jwe
parents: 4950
diff changeset
31 ## @end deftypefn
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
32 ##
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
33 ## @seealso{bitand,bitor,bitxor,bitset,bitget,bitcmp,bitshift,bitmax}
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
34
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
35 ## Liberally based of the version by Kai Habel from octave-forge
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
36
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
37 function X = bitcmp (A, n)
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
38
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
39 if (nargin < 1 || nargin > 2)
4920
b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe]
jwe
parents: 4916
diff changeset
40 usage ("bitcmp (A, n)");
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
41 endif
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
42
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
43 if (isa (A, "double"))
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
44 Bmax = bitmax;
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
45 Amax = log2 (Bmax) + 1;
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
46 _conv = @double;
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
47 else
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
48 if (isa (A, "uint8"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
49 Amax = 8;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
50 _conv = @uint8;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
51 elseif (isa (A, "uint16"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
52 Amax = 16;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
53 _conv = @uint16;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
54 elseif (isa (A, "uint32"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
55 Amax = 32;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
56 _conv = @uint32;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
57 elseif (isa (A, "uint64"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
58 Amax = 64;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
59 _conv = @uint64;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
60 elseif (isa (A, "int8"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
61 Amax = 8;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
62 _conv = @int8;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
63 elseif (isa (A, "int16"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
64 Amax = 16;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
65 _conv = @int16;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
66 elseif (isa (A, "int32"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
67 Amax = 32;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
68 _conv = @int32;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
69 elseif (isa (A, "int64"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
70 Amax = 64;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
71 _conv = @int64;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
72 else
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
73 error ("invalid class %s", class (A));
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
74 endif
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
75 Bmax = intmax (class (A));
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
76 endif
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
77
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
78 if (nargin == 2)
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
79 m = double (n(:));
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
80 if (any (m < 1) || any (m > Amax))
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
81 error ("n must be in the range [1,%d]", Amax);
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
82 endif
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
83 X = bitxor (A, bitshift (Bmax, -int8(n)));
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
84 else
4920
b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe]
jwe
parents: 4916
diff changeset
85 X = bitxor (A, Bmax);
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
86 endif
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
87
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
88 endfunction