annotate scripts/general/bitget.m @ 5053:c08cb1098afc

[project @ 2004-10-19 23:10:54 by jwe]
author jwe
date Tue, 19 Oct 2004 23:10:55 +0000
parents a0e7231a58eb
children 4c8a2e4e0717
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
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
15 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
16
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
17 ## -*- texinfo -*-
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
18 ## @deftypefn {Function File} {@var{X} =} bitget (@var{a},@var{n})
4920
b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe]
jwe
parents: 4916
diff changeset
19 ## Return the status of bit(s) @var{n} of unsigned integers in @var{a}
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
20 ## the lowest significant bit is @var{n} = 1.
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
21 ##
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
22 ## @example
4920
b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe]
jwe
parents: 4916
diff changeset
23 ## bitget (100, 8:-1:1)
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
24 ## @result{} 0 1 1 0 0 1 0 0
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
25 ## @end example
5053
c08cb1098afc [project @ 2004-10-19 23:10:54 by jwe]
jwe
parents: 5003
diff changeset
26 ## @end deftypefn
c08cb1098afc [project @ 2004-10-19 23:10:54 by jwe]
jwe
parents: 5003
diff changeset
27 ##
4920
b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe]
jwe
parents: 4916
diff changeset
28 ## @seealso{bitand, bitor, bitxor, bitset, bitcmp, bitshift, bitmax}
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
29
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
30 ## 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
31
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
32 function X = bitget (A, n)
4920
b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe]
jwe
parents: 4916
diff changeset
33
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
34 if (nargin != 2)
4920
b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe]
jwe
parents: 4916
diff changeset
35 usage ("bitget (A, n)");
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
36 endif
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
37
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
38 if (isa (A, "double"))
5003
a0e7231a58eb [project @ 2004-09-16 16:44:44 by jwe]
jwe
parents: 4950
diff changeset
39 Amax = log2 (bitmax) + 1;
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
40 _conv = @double;
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
41 else
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
42 if (isa (A, "uint8"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
43 Amax = 8;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
44 _conv = @uint8;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
45 elseif (isa (A, "uint16"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
46 Amax = 16;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
47 _conv = @uint16;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
48 elseif (isa (A, "uint32"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
49 Amax = 32;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
50 _conv = @uint32;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
51 elseif (isa (A, "uint64"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
52 Amax = 64;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
53 _conv = @uint64;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
54 elseif (isa (A, "int8"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
55 Amax = 8;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
56 _conv = @int8;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
57 elseif (isa (A, "int16"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
58 Amax = 16;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
59 _conv = @int16;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
60 elseif (isa (A, "int32"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
61 Amax = 32;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
62 _conv = @int32;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
63 elseif (isa (A, "int64"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
64 Amax = 64;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
65 _conv = @int64;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
66 else
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
67 error ("invalid class %s", class (A));
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
68 endif
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
69 endif
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
70
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
71 m = double (n(:));
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
72 if (any (m < 1) || any (m > Amax))
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
73 error ("n must be in the range [1,%d]", Amax);
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
74 endif
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
75
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
76 X = bitand (A, bitshift (_conv (1), uint8 (n) - uint8 (1))) != _conv (0);
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
77 endfunction