aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/bitclear.rst
blob: f48705960de758f547169742746dd9492ccf4faa (plain)
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
.. _lang-bitclear:

bitClear()
==========

(Macro) Clears (writes a 0 to) a bit of a numeric variable.

Syntax
------

``bitClear(x, n)``

Parameters
----------

* **x** the numeric variable whose bit to clear

* **n** which bit to clear, starting at 0 for the least-significant
  (rightmost) bit

Returns
-------

Nothing.

Arduino Compatibility
---------------------

The Maple implementation of ``bitClear()`` is compatible with Arduino.

See Also
--------

-  :ref:`bit <lang-bit>`\ ()
-  :ref:`bitRead <lang-bitread>`\ ()
-  :ref:`bitWrite <lang-bitwrite>`\ ()
-  :ref:`bitSet <lang-bitset>`\ ()

.. include:: /arduino-cc-attribution.txt