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 | a0549b4a15a7093f990fffa4bc1d2d52ec1c16e2 (patch) | |
| tree | 9c6383570be6d045db4d8942ca3137fc3cb5b8a0 /docs/source/lang/api/bitread.rst | |
| parent | 3b7f16dba295da3a0071564ac284c25dc56e6b18 (diff) | |
| download | librambutan-a0549b4a15a7093f990fffa4bc1d2d52ec1c16e2.tar.gz librambutan-a0549b4a15a7093f990fffa4bc1d2d52ec1c16e2.zip | |
docs, now with style
Diffstat (limited to 'docs/source/lang/api/bitread.rst')
| -rw-r--r-- | docs/source/lang/api/bitread.rst | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/source/lang/api/bitread.rst b/docs/source/lang/api/bitread.rst new file mode 100644 index 0000000..46b4478 --- /dev/null +++ b/docs/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 |