diff options
| author | Perry Hung <iperry@gmail.com> | 2011-01-24 23:23:29 -0500 |
|---|---|---|
| committer | Perry Hung <iperry@gmail.com> | 2011-01-24 23:23:29 -0500 |
| commit | c48689d34809943a5907884bd287cea9ae275352 (patch) | |
| tree | d49ff06b0d4b81f6ab0eac8060d178ce7542476c /docs/source/lang/api/bitread.rst | |
| parent | 64431fd4b59cb8656365f1fad5f679cd4d756239 (diff) | |
| parent | a9b2d70bc7799ca96c1673b18fe3012b1a4dd329 (diff) | |
| download | librambutan-c48689d34809943a5907884bd287cea9ae275352.tar.gz librambutan-c48689d34809943a5907884bd287cea9ae275352.zip | |
Merge remote branch 'leaf/master'
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 |