Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Add versionadded tags to new math functions.

This commit is contained in:
Georg Brandl 2008-06-18 09:28:22 +00:00
parent f88f739012
commit 5da652e374
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Doc/library/math.rst
View File

@ -42,11 +42,15 @@ Number-theoretic and representation functions:
Return the absolute value of *x*. Return the absolute value of *x*.
.. function:: factorial(x) .. function:: factorial(x)
Return *x* factorial. Raises :exc:`ValueError` if *x* is not integral or Return *x* factorial. Raises :exc:`ValueError` if *x* is not integral or
is negative. is negative.
.. versionadded:: 2.6
.. function:: floor(x) .. function:: floor(x)
Return the floor of *x* as a float, the largest integer value less than or equal Return the floor of *x* as a float, the largest integer value less than or equal
@ -107,6 +111,7 @@ Number-theoretic and representation functions:
Return the fractional and integer parts of *x*. Both results carry the sign of Return the fractional and integer parts of *x*. Both results carry the sign of
*x*, and both are floats. *x*, and both are floats.
.. function:: sum(iterable) .. function:: sum(iterable)
Return an accurate floating point sum of values in the iterable. Avoids Return an accurate floating point sum of values in the iterable. Avoids
@ -114,6 +119,9 @@ Number-theoretic and representation functions:
algorithm's accuracy depends on IEEE-754 arithmetic guarantees and the algorithm's accuracy depends on IEEE-754 arithmetic guarantees and the
typical case where the rounding mode is half-even. typical case where the rounding mode is half-even.
.. versionadded:: 2.6
.. function:: trunc(x) .. function:: trunc(x)
Return the :class:`Real` value *x* truncated to an :class:`Integral` (usually Return the :class:`Real` value *x* truncated to an :class:`Integral` (usually
@ -121,6 +129,7 @@ Number-theoretic and representation functions:
.. versionadded:: 2.6 .. versionadded:: 2.6
Note that :func:`frexp` and :func:`modf` have a different call/return pattern Note that :func:`frexp` and :func:`modf` have a different call/return pattern
than their C equivalents: they take a single argument and return a pair of than their C equivalents: they take a single argument and return a pair of
values, rather than returning their second return value through an 'output values, rather than returning their second return value through an 'output
@ -134,7 +143,6 @@ necessarily has no fractional bits.
Power and logarithmic functions: Power and logarithmic functions:
.. function:: exp(x) .. function:: exp(x)
Return ``e**x``. Return ``e**x``.
@ -179,8 +187,8 @@ Power and logarithmic functions:
Return the square root of *x*. Return the square root of *x*.
Trigonometric functions:
Trigonometric functions:
.. function:: acos(x) .. function:: acos(x)
@ -227,8 +235,8 @@ Trigonometric functions:
Return the tangent of *x* radians. Return the tangent of *x* radians.
Angular conversion:
Angular conversion:
.. function:: degrees(x) .. function:: degrees(x)
@ -239,8 +247,8 @@ Angular conversion:
Converts angle *x* from degrees to radians. Converts angle *x* from degrees to radians.
Hyperbolic functions:
Hyperbolic functions:
.. function:: acosh(x) .. function:: acosh(x)
@ -278,10 +286,8 @@ Hyperbolic functions:
Return the hyperbolic tangent of *x*. Return the hyperbolic tangent of *x*.
The module also defines two mathematical constants: The module also defines two mathematical constants:
.. data:: pi .. data:: pi
The mathematical constant *pi*. The mathematical constant *pi*.