diff options
| author | Hanna Mendes Levitin <hanna@anomaly-3.local> | 2010-12-01 03:37:07 -0600 |
|---|---|---|
| committer | Hanna Mendes Levitin <hanna@anomaly-3.local> | 2010-12-01 03:37:07 -0600 |
| commit | 5a7dd1bea32458a4afc038984a903959134b82d3 (patch) | |
| tree | 4171e71c34841212585f855a3fbdf8aaf3b9bb4e /source/lang/api/bitread.rst | |
| parent | 8e42d34c8d3c81c037a3acaca553ea8c5e4f25aa (diff) | |
| download | librambutan-5a7dd1bea32458a4afc038984a903959134b82d3.tar.gz librambutan-5a7dd1bea32458a4afc038984a903959134b82d3.zip | |
docs, now with style
Diffstat (limited to 'source/lang/api/bitread.rst')
| -rw-r--r-- | source/lang/api/bitread.rst | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/source/lang/api/bitread.rst b/source/lang/api/bitread.rst new file mode 100644 index 0000000..46b4478 --- /dev/null +++ b/source/lang/api/bitread.rst @@ -0,0 +1,46 @@ +.. _lang-bitread: + +bitRead() +========= + +(Macro) Gets the value of a bit in a number. + + +Syntax +------ + +``bitRead(x, n)`` + + +Parameters +---------- + +* **x** the number from which to read the bit. + +* **n** which bit to read, starting at 0 for the least-significant + (rightmost) bit + + +Value +----- + +The value of the bit (0 or 1). + + +Arduino Compatibility +--------------------- + +The Maple implementation of ``bitRead`` is compatible with Arduino. + + +See also +-------- + + +- :ref:`lang-bit` +- :ref:`lang-bitwrite` +- :ref:`lang-bitset` +- :ref:`lang-bitclear` + + +.. include:: cc-attribution.txt |