summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/math.rst
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2014-10-31 01:37:19 +0000
committerDamien George <damien.p.george@gmail.com>2014-10-31 01:37:19 +0000
commit88d3054ac072f9c73b0f3f045c59ba74f6730c1d (patch)
tree6db7851068908c0640b1ed306d6823871fd3d742 /docs/library/math.rst
parent7c4445afe104631d5fe8e7401d50f40f205e35b9 (diff)
downloadmicropython-88d3054ac072f9c73b0f3f045c59ba74f6730c1d.tar.gz
micropython-88d3054ac072f9c73b0f3f045c59ba74f6730c1d.zip
docs: Import documentation from source-code inline comments.
The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
Diffstat (limited to 'docs/library/math.rst')
-rw-r--r--docs/library/math.rst145
1 files changed, 145 insertions, 0 deletions
diff --git a/docs/library/math.rst b/docs/library/math.rst
new file mode 100644
index 0000000000..53427ea557
--- /dev/null
+++ b/docs/library/math.rst
@@ -0,0 +1,145 @@
+:mod:`math` --- mathematical functions
+======================================
+
+.. module:: math
+ :synopsis: mathematical functions
+
+The ``math`` module provides some basic mathematical funtions for
+working with floating-point numbers.
+
+
+Functions
+---------
+
+.. function:: acos(x)
+
+
+.. function:: acosh(x)
+
+
+.. function:: asin(x)
+
+
+.. function:: asinh(x)
+
+
+.. function:: atan(x)
+
+
+.. function:: atan2(y, x)
+
+
+.. function:: atanh(x)
+
+
+.. function:: ceil(x)
+
+
+.. function:: copysign(x, y)
+
+
+.. function:: cos(x)
+
+
+.. function:: cosh(x)
+
+
+.. function:: degrees(x)
+
+
+.. function:: erf(x)
+
+ Return the error function of ``x``.
+
+.. function:: erfc(x)
+
+ Return the complementary error function of ``x``.
+
+.. function:: exp(x)
+
+
+.. function:: expm1(x)
+
+
+.. function:: fabs(x)
+
+
+.. function:: floor(x)
+
+
+.. function:: fmod(x, y)
+
+
+.. function:: frexp(x)
+
+ Converts a floating-point number to fractional and integral components.
+
+.. function:: gamma(x)
+
+ Return the gamma function of ``x``.
+
+.. function:: isfinite(x)
+
+
+.. function:: isinf(x)
+
+
+.. function:: isnan(x)
+
+
+.. function:: ldexp(x, exp)
+
+
+.. function:: lgamma(x)
+
+ return the natural logarithm of the gamma function of ``x``.
+
+.. function:: log(x)
+
+
+.. function:: log10(x)
+
+
+.. function:: log2(x)
+
+
+.. function:: modf(x)
+
+
+.. function:: pow(x, y)
+
+ Returns ``x`` to the power of ``y``.
+
+.. function:: radians(x)
+
+
+.. function:: sin(x)
+
+
+.. function:: sinh(x)
+
+
+.. function:: sqrt(x)
+
+ Returns the square root of ``x``.
+
+.. function:: tan(x)
+
+
+.. function:: tanh(x)
+
+
+.. function:: trunc(x)
+
+
+
+Constants
+---------
+
+.. data:: e
+
+ base of the natural logarithm
+
+.. data:: pi
+
+ the ratio of a circle's circumference to its diameter