Mercurial > hg > octave-nkf

annotate scripts/general/bitget.m @ 12795:9e7ebbaf69ff

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
codesprint: new tests for files in scripts/general directory * bitget.m, bitset.m, colon.m, common_size.m, flipdim.m, isdir.m, nextpow2.m, postpad.m, prepad.m, rat.m, rotdim.m: New tests.
author John W. Eaton <jwe@octave.org>
date Sat, 16 Jul 2011 12:46:22 -0400
parents 139f993936af
children 72c96de7a403
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11469
diff changeset
1 ## Copyright (C) 2004-2011 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: 6046
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: 6046
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: 6046
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: 6046
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: 6046
diff changeset
8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
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: 6046
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
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: 6046
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: 6046
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: 6046
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 -*-
11563
3c6e8aaa9555 Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
20 ## @deftypefn {Function File} {@var{c} =} bitget (@var{A}, @var{n})
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10635
diff changeset
21 ## 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
22 ## the lowest significant bit is @var{n} = 1.
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
23 ##
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
24 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7017
diff changeset
25 ## @group
4920
b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe]
jwe
parents: 4916
diff changeset
26 ## bitget (100, 8:-1:1)
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
27 ## @result{} 0 1 1 0 0 1 0 0
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7017
diff changeset
28 ## @end group
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
29 ## @end example
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
30 ## @seealso{bitand, bitor, bitxor, bitset, bitcmp, bitshift, bitmax}
5053
c08cb1098afc [project @ 2004-10-19 23:10:54 by jwe]
jwe
parents: 5003
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 ## 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
34
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10635
diff changeset
35 function C = bitget (A, n)
4920
b22a7a1db0d5 [project @ 2004-07-27 18:15:25 by jwe]
jwe
parents: 4916
diff changeset
36
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
37 if (nargin != 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
38 print_usage ();
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
39 endif
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
40
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
41 if (isa (A, "double"))
5003
a0e7231a58eb [project @ 2004-09-16 16:44:44 by jwe]
jwe
parents: 4950
diff changeset
42 Amax = log2 (bitmax) + 1;
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
43 _conv = @double;
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
44 else
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
45 if (isa (A, "uint8"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
46 Amax = 8;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
47 _conv = @uint8;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
48 elseif (isa (A, "uint16"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
49 Amax = 16;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
50 _conv = @uint16;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
51 elseif (isa (A, "uint32"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
52 Amax = 32;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
53 _conv = @uint32;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
54 elseif (isa (A, "uint64"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
55 Amax = 64;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
56 _conv = @uint64;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
57 elseif (isa (A, "int8"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
58 Amax = 8;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
59 _conv = @int8;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
60 elseif (isa (A, "int16"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
61 Amax = 16;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
62 _conv = @int16;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
63 elseif (isa (A, "int32"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
64 Amax = 32;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
65 _conv = @int32;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
66 elseif (isa (A, "int64"))
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
67 Amax = 64;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
68 _conv = @int64;
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
69 else
10635
d1978e7364ad Print name of function in error() string messages.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
70 error ("bitget: invalid class %s", class (A));
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
71 endif
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
72 endif
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
73
4950
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
74 m = double (n(:));
0896307b1b48 [project @ 2004-08-31 21:26:35 by jwe]
jwe
parents: 4920
diff changeset
75 if (any (m < 1) || any (m > Amax))
12480
139f993936af Uppercase variables in script error strings.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
76 error ("bitget: N must be in the range [1,%d]", Amax);
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
77 endif
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
78
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10635
diff changeset
79 C = bitand (A, bitshift (_conv (1), uint8 (n) - uint8 (1))) != _conv (0);
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10635
diff changeset
80
4916
c45f14873b5e [project @ 2004-07-26 14:35:12 by jwe]
jwe
parents:
diff changeset
81 endfunction
12795
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
82
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
83 %!error bitget (1);
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
84 %!error bitget (1, 2, 3);
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
85
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
86 %!test
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
87 %! assert (bitget ([4, 14], [3, 3]), logical ([1, 1]));
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
88 %! pfx = {"", "u"};
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
89 %! for i = 1:2
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
90 %! for prec = [8, 16, 32, 64]
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
91 %! fcn = str2func (sprintf ("%sint%d", pfx{i}, prec));
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
92 %! assert (bitget (fcn ([4, 14]), [3, 3]), logical ([1, 1]));
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
93 %! endfor
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
94 %! endfor
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
95
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
96 %!error bitget (0, 0);
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
97 %!error bitget (0, 55);
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
98
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
99 %!error bitget (int8 (0), 9);
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
100 %!error bitget (uint8 (0), 9);
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
101
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
102 %!error bitget (int16 (0), 17);
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
103 %!error bitget (uint16 (0), 17);
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
104
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
105 %!error bitget (int32 (0), 33);
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
106 %!error bitget (uint32 (0), 33);
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
107
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
108 %!error bitget (int64 (0), 65);
9e7ebbaf69ff codesprint: new tests for files in scripts/general directory
John W. Eaton <jwe@octave.org>
parents: 12480
diff changeset
109 %!error bitget (uint64 (0), 65);