djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
circuitpython/docs/library/math.rst

186 lines
3.4 KiB
ReStructuredText
Raw Normal View History

docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
:mod:`math` -- mathematical functions
=====================================
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.
2014-10-30 21:37:19 -04:00
.. module:: math
:synopsis: mathematical functions
docs/library: Add CPython docs xref to each pertinent module. Cross-reference text/link is implemented as RST substitution, so easy to consistently.
2017-07-02 08:37:31 -04:00
|see_cpython_module| :mod:`python:math`.
docs/math: Typo fix.
2016-06-01 15:09:51 -04:00
The ``math`` module provides some basic mathematical functions for
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.
2014-10-30 21:37:19 -04:00
working with floating-point numbers.
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
*Note:* On the pyboard, floating-point numbers have 32-bit precision.
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.
2014-10-30 21:37:19 -04:00
docs: math, cmath: Add port availability information.
2016-06-01 15:12:39 -04:00
Availability: not available on WiPy. Floating point support required
for this module.
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.
2014-10-30 21:37:19 -04:00
Functions
---------
.. function:: acos(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the inverse cosine of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: acosh(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the inverse hyperbolic cosine of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: asin(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the inverse sine of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: asinh(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the inverse hyperbolic sine of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: atan(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the inverse tangent of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: atan2(y, x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the principal value of the inverse tangent of ``y/x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: atanh(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the inverse hyperbolic tangent of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: ceil(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return an integer, being ``x`` rounded towards positive infinity.
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.
2014-10-30 21:37:19 -04:00
.. function:: copysign(x, y)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return ``x`` with the sign of ``y``.
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.
2014-10-30 21:37:19 -04:00
.. function:: cos(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the cosine of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: cosh(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the hyperbolic cosine of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: degrees(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return radians ``x`` converted to degrees.
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.
2014-10-30 21:37:19 -04:00
.. function:: erf(x)
Return the error function of ``x``.
.. function:: erfc(x)
Return the complementary error function of ``x``.
.. function:: exp(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the exponential of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: expm1(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return ``exp(x) - 1``.
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.
2014-10-30 21:37:19 -04:00
.. function:: fabs(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the absolute value of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: floor(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return an integer, being ``x`` rounded towards negative infinity.
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.
2014-10-30 21:37:19 -04:00
.. function:: fmod(x, y)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the remainder of ``x/y``.
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.
2014-10-30 21:37:19 -04:00
.. function:: frexp(x)
docs: Correct the documentation for math.frexp.
2015-02-23 17:15:11 -05:00
Decomposes a floating-point number into its mantissa and exponent.
The returned value is the tuple ``(m, e)`` such that ``x == m * 2**e``
exactly. If ``x == 0`` then the function returns ``(0.0, 0)``, otherwise
the relation ``0.5 <= abs(m) < 1`` holds.
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.
2014-10-30 21:37:19 -04:00
.. function:: gamma(x)
Return the gamma function of ``x``.
.. function:: isfinite(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return ``True`` if ``x`` is finite.
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.
2014-10-30 21:37:19 -04:00
.. function:: isinf(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return ``True`` if ``x`` is infinite.
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.
2014-10-30 21:37:19 -04:00
.. function:: isnan(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return ``True`` if ``x`` is not-a-number
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.
2014-10-30 21:37:19 -04:00
.. function:: ldexp(x, exp)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return ``x * (2**exp)``.
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.
2014-10-30 21:37:19 -04:00
.. function:: lgamma(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the natural logarithm of the gamma function of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: log(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the natural logarithm of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: log10(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the base-10 logarithm of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: log2(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the base-2 logarithm of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: modf(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return a tuple of two floats, being the fractional and integral parts of
``x``. Both return values have the same sign as ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: pow(x, y)
Returns ``x`` to the power of ``y``.
.. function:: radians(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return degrees ``x`` converted to radians.
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.
2014-10-30 21:37:19 -04:00
.. function:: sin(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the sine of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: sinh(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the hyperbolic sine of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: sqrt(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the square root of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: tan(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the tangent of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: tanh(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return the hyperbolic tangent of ``x``.
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.
2014-10-30 21:37:19 -04:00
.. function:: trunc(x)
docs: Cleanup and update some docs.
2014-10-31 18:21:37 -04:00
Return an integer, being ``x`` rounded towards 0.
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.
2014-10-30 21:37:19 -04:00
Constants
---------
.. data:: e
base of the natural logarithm
.. data:: pi
the ratio of a circle's circumference to its diameter