mirrors
/
micropython
mirror of https://github.com/micropython/micropython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
micropython/docs/library/cmath.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

64 lines
1.3 KiB
ReStructuredText
Raw Normal View History

docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
:mod:`cmath` -- mathematical functions for complex numbers
==========================================================
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-31 01:37:19 +00:00
.. module:: cmath
:synopsis: mathematical functions for complex numbers
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 13:37:31 +01:00
|see_cpython_module| :mod:`python:cmath`.
docs: math, cmath: Add port availability information.
2016-06-01 20:12:39 +01:00
The ``cmath`` 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-31 01:37:19 +00:00
working with complex numbers.
docs: math, cmath: Add port availability information.
2016-06-01 20:12:39 +01:00
Availability: not available on WiPy and ESP8266. 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-31 01:37:19 +00:00
Functions
---------
.. function:: cos(z)
Return the cosine of ``z``.
.. function:: exp(z)
Return the exponential of ``z``.
.. function:: log(z)
Return the natural logarithm of ``z``. The branch cut is along the negative real axis.
.. function:: log10(z)
Return the base-10 logarithm of ``z``. The branch cut is along the negative real axis.
.. function:: phase(z)
Returns the phase of the number ``z``, in the range (-pi, +pi].
.. function:: polar(z)
Returns, as a tuple, the polar form of ``z``.
.. function:: rect(r, phi)
Returns the complex number with modulus ``r`` and phase ``phi``.
.. function:: sin(z)
Return the sine of ``z``.
.. function:: sqrt(z)
Return the square-root of ``z``.
Constants
---------
.. data:: e
base of the natural logarithm
.. data:: pi
the ratio of a circle's circumference to its diameter