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/arduino/constrain.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/arduino/constrain.rst')
| -rw-r--r-- | docs/source/arduino/constrain.rst | 60 |
1 files changed, 0 insertions, 60 deletions
diff --git a/docs/source/arduino/constrain.rst b/docs/source/arduino/constrain.rst deleted file mode 100644 index 2769219..0000000 --- a/docs/source/arduino/constrain.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. _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>`_\ () - - |