aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/pow.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-11-28 11:23:33 -0500
committerMarti Bolivar <mbolivar@mit.edu>2010-11-28 11:23:33 -0500
commit5e587be27a7c3bd854b686952a5c9637a2432ff0 (patch)
tree09d4ceeb46f19287ee874a24516c68be90c9ad8e /docs/source/lang/pow.rst
parentdb4ff6ba53e9b702c77411ae19cd53d914a675de (diff)
downloadlibrambutan-5e587be27a7c3bd854b686952a5c9637a2432ff0.tar.gz
librambutan-5e587be27a7c3bd854b686952a5c9637a2432ff0.zip
reorganized all the arduino/ docs into a lang/ subdirectory since
they're properly CC attributed now.
Diffstat (limited to 'docs/source/lang/pow.rst')
-rw-r--r--docs/source/lang/pow.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/source/lang/pow.rst b/docs/source/lang/pow.rst
new file mode 100644
index 0000000..dbe89b6
--- /dev/null
+++ b/docs/source/lang/pow.rst
@@ -0,0 +1,29 @@
+.. _lang-pow:
+
+pow(base, exponent)
+===================
+
+Calculates the value of a number raised to a power.
+
+Library Documentation
+---------------------
+
+.. doxygenfunction:: pow
+
+Example
+-------
+
+``pow()`` can be used to raise a number to a fractional power. This
+is useful for e.g. generating exponential mapping of values or
+curves. See the `fscale <http://arduino.cc/playground/main/fscale>`_
+function in the Arduino playground for more on this.
+
+See Also
+--------
+
+- :ref:`sqrt() <lang-sqrt>`
+- :ref:`float <lang-float>`
+- :ref:`double <lang-double>`
+
+
+.. include:: cc-attribution.txt