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/modulo.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/modulo.rst')
-rw-r--r-- | docs/source/arduino/modulo.rst | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/docs/source/arduino/modulo.rst b/docs/source/arduino/modulo.rst new file mode 100644 index 0000000..195d15b --- /dev/null +++ b/docs/source/arduino/modulo.rst @@ -0,0 +1,84 @@ +.. _arduino-modulo: + +% (modulo) +========== + +Description +----------- + +Calculates the remainder when one integer is divided by another. It +is useful for keeping a variable within a particular range (e.g. +the size of an array). + + + +Syntax +------ + +result = dividend % divisor + + + +Parameters +---------- + +dividend: the number to be divided + + + +divisor: the number to divide by + + + +Returns +------- + +the remainder + + + +Examples +-------- + +:: + + x = 7 % 5; // x now contains 2 + x = 9 % 5; // x now contains 4 + x = 5 % 5; // x now contains 0 + x = 4 % 5; // x now contains 4 + + + +Example Code +------------ + +:: + + /* update one value in an array each time through a loop */ + + int values[10]; + int i = 0; + + void setup() {} + + void loop() + { + values[i] = analogRead(0); + i = (i + 1) % 10; // modulo operator rolls over variable + } + + + +Tip +--- + +The modulo operator does not work on floats. + + + +See also +-------- + + +- `division <http://arduino.cc/en/Reference/Arithmetic>`_ + |