aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/pow.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/arduino/pow.rst')
-rw-r--r--docs/source/arduino/pow.rst47
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/source/arduino/pow.rst b/docs/source/arduino/pow.rst
new file mode 100644
index 0000000..3a09481
--- /dev/null
+++ b/docs/source/arduino/pow.rst
@@ -0,0 +1,47 @@
+.. _arduino-pow:
+
+pow(base, exponent)
+===================
+
+Description
+-----------
+
+Calculates the value of a number raised to a power. Pow() can be
+used to raise a number to a fractional power. This is useful for
+generating exponential mapping of values or curves.
+
+
+
+Parameters
+----------
+
+base: the number (*float*)
+
+
+
+exponent: the power to which the base is raised (*float*)
+
+
+
+Returns
+-------
+
+The result of the exponentiation (*double*)
+
+
+
+Example
+-------
+
+See the `fscale <http://arduino.cc/playground/Main/Fscale>`_
+function in the code library.
+
+
+
+See also
+--------
+
+
+- `sqrt <http://arduino.cc/en/Reference/Sqrt>`_\ ()
+- `float <http://arduino.cc/en/Reference/Float>`_
+- `double <http://arduino.cc/en/Reference/Double>`_