diff options
author | Marti Bolivar <mbolivar@mit.edu> | 2010-10-20 06:46:52 -0400 |
---|---|---|
committer | Marti Bolivar <mbolivar@mit.edu> | 2010-10-20 06:46:52 -0400 |
commit | 22ff1db8a76c7047b61a424ae1fa5f43697fcb34 (patch) | |
tree | bf722c8a5a6bd40e0b33fc4a425e0e5b8b9f4216 /docs/source/arduino/constrain.rst | |
parent | bac6548fe90b0721e191d68df2677beb4b15f60a (diff) | |
download | librambutan-22ff1db8a76c7047b61a424ae1fa5f43697fcb34.tar.gz librambutan-22ff1db8a76c7047b61a424ae1fa5f43697fcb34.zip |
initial check-in of arduino docs in RST format (converted using wget+pandoc)
Diffstat (limited to 'docs/source/arduino/constrain.rst')
-rw-r--r-- | docs/source/arduino/constrain.rst | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/source/arduino/constrain.rst b/docs/source/arduino/constrain.rst new file mode 100644 index 0000000..2769219 --- /dev/null +++ b/docs/source/arduino/constrain.rst @@ -0,0 +1,60 @@ +.. _arduino-constrain: + +constrain(x, a, b) +================== + +Description +----------- + +Constrains a number to be within a range. + + + +Parameters +---------- + +x: the number to constrain, all data types + + + +a: the lower end of the range, all data types + + + +b: the upper end of the range, all data types + + + +Returns +------- + +**x**: if **x** is between **a** and **b** + + + +**a**: if **x** is less than **a** + + + +**b**: if **x** is greater than **b** + + + +Example +------- + +:: + + sensVal = constrain(sensVal, 10, 150); + // limits range of sensor values to between 10 and 150 + + + +See also +-------- + + +- `min <http://arduino.cc/en/Reference/Min>`_\ () +- `max <http://arduino.cc/en/Reference/Max>`_\ () + + |