aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/map.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 19:25:29 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 20:05:33 -0400
commit0c2b3c667bf157dc2344e3dbc2aae0e11e37387b (patch)
tree3008ee192c80f17f640ebdeb870442e78415ce6b /docs/source/lang/api/map.rst
parentd4b576fcadecf66b7b754af7d204bb6f3b4a9830 (diff)
downloadlibrambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.tar.gz
librambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.zip
Remove reST documentation, attendant updates.
The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation
Diffstat (limited to 'docs/source/lang/api/map.rst')
-rw-r--r--docs/source/lang/api/map.rst68
1 files changed, 0 insertions, 68 deletions
diff --git a/docs/source/lang/api/map.rst b/docs/source/lang/api/map.rst
deleted file mode 100644
index 69661a0..0000000
--- a/docs/source/lang/api/map.rst
+++ /dev/null
@@ -1,68 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-map:
-
-map()
-=====
-
-Re-maps a number from one range to another.
-
-.. contents:: Contents
- :local:
-
-Library Documentation
----------------------
-
-.. doxygenfunction:: map
-
-Discussion
-----------
-
-``map()`` does not constrain values to within the range, because
-out-of-range values are sometimes intended and useful. The
-:ref:`constrain() <lang-constrain>` macro may be used either before or
-after this function, if limits to the ranges are desired.
-
-Note that the "lower bounds" of either range may be larger or smaller
-than the "upper bounds" so that ``map()`` may be used to reverse a
-range of numbers; for example::
-
- y = map(x, 1, 50, 50, 1);
-
-The function also handles negative numbers well, so that this
-example ::
-
- y = map(x, 1, 50, 50, -100);
-
-is also valid.
-
-The ``map()`` function uses integer math (its arguments and return
-values all have type :ref:`long <lang-long>`), so it will not generate
-fractions, when the math might indicate that it should do so.
-Fractional remainders are truncated, and are not rounded or averaged.
-
-Example
--------
-
-::
-
- /* Map an ADC reading (12 bits) to 16-bit PWM (0 to 65,535) */
-
- void setup() {
- pinMode(0, INPUT_ANALOG);
- pinMode(9, PWM);
- }
-
- void loop() {
- int val = analogRead(0);
- val = map(val, 0, 4095, 0, 65535);
- analogWrite(9, val);
- }
-
-
-See Also
---------
-
-- :ref:`constrain() <lang-constrain>`
-
-.. include:: /arduino-cc-attribution.txt