From 5a7dd1bea32458a4afc038984a903959134b82d3 Mon Sep 17 00:00:00 2001
From: Hanna Mendes Levitin <hanna@anomaly-3.local>
Date: Wed, 1 Dec 2010 03:37:07 -0600
Subject: docs, now with style

---
 source/lang/cpp/modulo.rst | 70 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 source/lang/cpp/modulo.rst

(limited to 'source/lang/cpp/modulo.rst')

diff --git a/source/lang/cpp/modulo.rst b/source/lang/cpp/modulo.rst
new file mode 100644
index 0000000..289fba0
--- /dev/null
+++ b/source/lang/cpp/modulo.rst
@@ -0,0 +1,70 @@
+.. highlight:: cpp
+
+.. _lang-modulo:
+
+Modulo Operator (``%``)
+=======================
+
+Calculates the `remainder <http://en.wikipedia.org/wiki/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
+------
+
+::
+
+    dividend % divisor
+
+Parameters
+----------
+
+**dividend**: the number to be divided
+
+**divisor**: the number to divide by
+
+Returns
+-------
+
+The remainder of **dividend**\ /\ **divisor**\ .
+
+Examples
+--------
+
+::
+
+    int x;
+    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
+
+::
+
+    /* update one value in an array each time through a loop */
+
+    int values[10];
+    int i = 0;
+
+    void setup() {
+        // no setup necessary
+    }
+
+    void loop() {
+      values[i] = analogRead(0);
+      i = (i + 1) % 10;   // modulo operator makes sure i stays between 0 and 9
+    }
+
+Tip
+---
+
+The modulo operator does not work on floats.  For that, you can use
+the C standard library function `fmod()
+<http://sourceware.org/newlib/libm.html#fmod>`_.
+
+See Also
+--------
+
+-  :ref:`Arithmetic <lang-arithmetic>`
+
+.. include:: cc-attribution.txt
-- 
cgit v1.2.3