1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
.. _arduino-bitwisecompound:
compound bitwise AND (&=), compound bitwise OR (\|=)
====================================================
The compound bitwise operators perform their calculations at the
bit level of variables. They are often used to clear and set
specific bits of a variable.
See the
`bitwise AND (&) <http://arduino.cc/en/Reference/BitwiseAnd>`_ and
`bitwise OR (\|) <http://arduino.cc/en/Reference/BitwiseAnd>`_
operators for the details of their operation, and also the
`Bitmath Tutorial <http://www.arduino.cc/playground/Code/BitMath>`_
for more information on bitwise operators.
compound bitwise AND (&=)
=========================
Description
-----------
The compound bitwise AND operator (&=) is often used with a
variable and a constant to force particular bits in a variable to
the LOW state (to 0). This is often referred to in programming
guides as "clearing" or "resetting" bits.
Syntax:
-------
::
x &= y; // equivalent to x = x & y;
Parameters
----------
x: a char, int or long variable
y: an integer constant or char, int, or long
Example:
--------
First, a review of the Bitwise AND (&) operator
::
0 0 1 1 operand1
0 1 0 1 operand2
----------
0 0 0 1 (operand1 & operand2) - returned result
Bits that are "bitwise ANDed" with 0 are cleared to 0 so, if myByte
is a byte variable,
``myByte & B00000000 = 0;``
Bits that are "bitwise ANDed" with 1 are unchanged so,
``myByte & B11111111 = myByte;``
Note: because we are dealing with bits in a bitwise operator - it
is convenient to use the binary formatter with
`constants. <http://arduino.cc/en/Reference/IntegerConstants>`_ The
numbers are still the same value in other representations, they are
just not as easy to understand. Also, B00000000 is shown for
clarity, but zero in any number format is zero (hmmm something
philosophical there?)
Consequently - to clear (set to zero) bits 0 & 1 of a variable,
while leaving the rest of the variable unchanged, use the compound
bitwise AND operator (&=) with the constant B11111100
::
1 0 1 0 1 0 1 0 variable
1 1 1 1 1 1 0 0 mask
----------------------
1 0 1 0 1 0 0 0
variable unchanged
bits cleared
Here is the same representation with the variable's bits replaced
with the symbol x
::
x x x x x x x x variable
1 1 1 1 1 1 0 0 mask
----------------------
x x x x x x 0 0
variable unchanged
bits cleared
So if:
::
myByte = 10101010;
myByte &= B1111100 == B10101000;
compound bitwise OR (\|=)
=========================
Description
-----------
The compound bitwise OR operator (\|=) is often used with a
variable and a constant to "set" (set to 1) particular bits in a
variable.
Syntax:
-------
::
x |= y; // equivalent to x = x | y;
Parameters
----------
x: a char, int or long variable
y: an integer constant or char, int, or long
Example:
--------
First, a review of the Bitwise OR (\|) operator
::
0 0 1 1 operand1
0 1 0 1 operand2
----------
0 1 1 1 (operand1 | operand2) - returned result
Bits that are "bitwise ORed" with 0 are unchanged, so if myByte is
a byte variable,
myByte \| B00000000 = myByte;
Bits that are "bitwise ORed" with 1 are set to 1 so:
myByte & B11111111 = B11111111;
Consequently - to set bits 0 & 1 of a variable, while leaving the
rest of the variable unchanged, use the compound bitwise AND
operator (&=) with the constant B00000011
::
1 0 1 0 1 0 1 0 variable
0 0 0 0 0 0 1 1 mask
----------------------
1 0 1 0 1 0 1 1
variable unchanged
bits set
Here is the same representation with the variables bits replaced
with the symbol x
::
x x x x x x x x variable
0 0 0 0 0 0 1 1 mask
----------------------
x x x x x x 1 1
variable unchanged
bits set
So if:
::
myByte = B10101010;
myByte |= B00000011 == B10101011;
See Also
- `& <http://arduino.cc/en/Reference/BitwiseAnd>`_ (bitwise AND)
- `\| <http://arduino.cc/en/Reference/BitwiseAnd>`_ (bitwise OR)
- `&& <http://arduino.cc/en/Reference/Boolean>`_ (Boolean AND)
- `\|\| <http://arduino.cc/en/Reference/Boolean>`_ (Boolean OR)
|
