annotate BitArray.hpp @ 54:f339499ecd79

Remove multiplexing. Comment on defines which should be removed from header.
author Tom Fredrik Blenning Klaussen <bfg@blenning.no>
date Thu, 13 Sep 2012 23:40:46 +0200
parents 725b0d776f3c
children 9161e9fd5b3f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
47
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
1 #ifndef BITARRAY_HPP
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
2 #define BITARRAY_HPP
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
3
52
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
4 #include <ostream>
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
5
54
f339499ecd79 Remove multiplexing.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 52
diff changeset
6 //We should remove these defines from the header, but we keep them for
f339499ecd79 Remove multiplexing.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 52
diff changeset
7 //now until we have stabilized the API and removed any bugs.
47
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
8 #define HIGH(B) ((B) >> 3)
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
9 #define LOW(B) ((B) & 0x07)
52
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
10 #define MASK(X) (0x1 << (7 - X))
47
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
11 #define SELECTMASK(X) (uchar(MASK(X)))
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
12 #define DESELECTMASK(X) (uchar(~MASK(X)))
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
13 #define NUMCHARS(X) HIGH(X + 7)
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
14
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
15 #include <cassert>
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
16
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
17 class QBitArray;
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
18 class BitArray
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
19 {
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
20 typedef unsigned char uchar;
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
21 typedef unsigned int uint;
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
22 uint size_;
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
23 unsigned char* bits;
52
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
24
47
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
25 public:
52
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
26 BitArray(uint size, bool val) : size_(size), bits(new uchar[NUMCHARS(size)])
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
27 {
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
28 uint n = NUMCHARS(size);
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
29 for (uint i = 0; i < n; ++i) {
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
30 bits[i] = (val) ? 0xff : 0;
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
31 }
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
32 }
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
33
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
34 BitArray(uint size) : size_(size), bits(new uchar[NUMCHARS(size)])
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
35 {
54
f339499ecd79 Remove multiplexing.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 52
diff changeset
36 //We need to initialize the bits beyond size, since they are
f339499ecd79 Remove multiplexing.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 52
diff changeset
37 //implicitly used in certain functions.
52
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
38 bits[NUMCHARS(size) - 1] = 0;
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
39 }
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
40
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
41 BitArray() : size_(0), bits(0)
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
42 {
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
43 }
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
44
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
45 BitArray(const BitArray& );
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
46
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
47 ~BitArray();
47
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
48 bool testBit(uint i) const
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
49 {
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
50 assert(i < size_);
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
51 return bits[HIGH(i)] & MASK(LOW(i));
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
52 }
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
53
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
54 void setBit(uint i, bool val)
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
55 {
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
56 assert(i < size_);
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
57 if (val) {
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
58 bits[HIGH(i)] |= SELECTMASK(LOW(i));
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
59 }
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
60 else {
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
61 bits[HIGH(i)] &= DESELECTMASK(LOW(i));
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
62 }
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
63 }
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
64
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
65 uint size() const
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
66 {
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
67 return size_;
52
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
68 }
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
69
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
70 uchar getPaddedChar(size_t offset = 0) const
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
71 {
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
72 assert(size_ > 0);
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
73 assert(HIGH(offset) < NUMCHARS(size_));
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
74 if (LOW(offset) == 0)
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
75 return bits[HIGH(offset)];
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
76
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
77 uchar next = ((HIGH(offset) + 1) < NUMCHARS(size_)) ?
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
78 bits[HIGH(offset) + 1] : 0;
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
79 return ((bits[HIGH(offset)] << 8) | next) >> (8 - LOW(offset));
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
80 }
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
81
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
82
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
83 bool operator==(const BitArray& rhs) const;
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
84 BitArray& operator=(const BitArray& rhs);
47
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
85 };
52
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
86
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
87 std::ostream& operator<<(std::ostream& out, const BitArray& rhs);
725b0d776f3c Fix a lot of problems with BitArray and reorganize which functions are
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents: 47
diff changeset
88
47
b23f04d4a276 Test a custom BitArray.
Tom Fredrik Blenning Klaussen <bfg@blenning.no>
parents:
diff changeset
89 #endif //BITARRAY_HPP