diff options
| author | Marti Bolivar <mbolivar@mit.edu> | 2010-10-25 21:15:28 -0400 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@mit.edu> | 2010-11-17 12:44:28 -0500 |
| commit | 2d429e75ce69e77f8c95490ac03881ec9aa0354a (patch) | |
| tree | a3b810a6c75625b07a4b976e5d1e319c60e19a6b /source/arduino/bit.rst | |
| parent | 30ac55d80c18e93f9c39a6dd850c10f9e7fd92ac (diff) | |
| download | librambutan-2d429e75ce69e77f8c95490ac03881ec9aa0354a.tar.gz librambutan-2d429e75ce69e77f8c95490ac03881ec9aa0354a.zip | |
arduino language reference nearing completion, properly CC-BY-SA 3.0 attributed
Diffstat (limited to 'source/arduino/bit.rst')
| -rw-r--r-- | source/arduino/bit.rst | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/source/arduino/bit.rst b/source/arduino/bit.rst index f8241a5..b74ad3d 100644 --- a/source/arduino/bit.rst +++ b/source/arduino/bit.rst @@ -6,37 +6,40 @@ bit() Description ----------- -Computes the value of the specified bit (bit 0 is 1, bit 1 is 2, -bit 2 is 4, etc.). - +(Macro) Computes the value of an (unsigned) integer with the specified +bit set (``bit(0)`` is 1, ``bit(1)`` is 2, ``bit(2)`` is 4, then 8, +16, 32, etc.). Syntax ------ -bit(n) - +``bit(n)`` Parameters ---------- -n: the bit whose value to compute +* **n** the bit to set. + +Value +----- +The value of an integer with the given bit set. -Returns -------- -the value of the bit +Arduino Compatibility +--------------------- +The Maple implementation of bit is compatible with Arduino. See also -------- -- `bitRead <http://arduino.cc/en/Reference/BitRead>`_\ () -- `bitWrite <http://arduino.cc/en/Reference/BitWrite>`_\ () -- `bitSet <http://arduino.cc/en/Reference/BitSet>`_\ () -- `bitClear <http://arduino.cc/en/Reference/BitClear>`_\ () +- :ref:`arduino-bitread` +- :ref:`arduino-bitwrite` +- :ref:`arduino-bitset` +- :ref:`arduino-bitclear` |