Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 1 | \section{Built-in Module \sectcode{math}} |
Guido van Rossum | e47da0a | 1997-07-17 16:34:52 +0000 | [diff] [blame] | 2 | \label{module-math} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 3 | |
| 4 | \bimodindex{math} |
| 5 | \renewcommand{\indexsubitem}{(in module math)} |
| 6 | This module is always available. |
| 7 | It provides access to the mathematical functions defined by the C |
| 8 | standard. |
| 9 | They are: |
Fred Drake | b55e07f | 1997-09-30 21:59:27 +0000 | [diff] [blame] | 10 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 11 | \begin{funcdesc}{acos}{x} |
Fred Drake | b55e07f | 1997-09-30 21:59:27 +0000 | [diff] [blame] | 12 | Return the arc cosine of \var{x}. |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 13 | \end{funcdesc} |
Fred Drake | b55e07f | 1997-09-30 21:59:27 +0000 | [diff] [blame] | 14 | |
| 15 | \begin{funcdesc}{asin}{x} |
| 16 | Return the arc sine of \var{x}. |
| 17 | \end{funcdesc} |
| 18 | |
| 19 | \begin{funcdesc}{atan}{x} |
| 20 | Return the arc tangent of \var{x}. |
| 21 | \end{funcdesc} |
| 22 | |
| 23 | \begin{funcdesc}{atan2}{x, y} |
| 24 | Return \code{atan(x / y)}. |
| 25 | \end{funcdesc} |
| 26 | |
| 27 | \begin{funcdesc}{ceil}{x} |
| 28 | Return the ceiling of \var{x}. |
| 29 | \end{funcdesc} |
| 30 | |
| 31 | \begin{funcdesc}{cos}{x} |
| 32 | Return the cosine of \var{x}. |
| 33 | \end{funcdesc} |
| 34 | |
| 35 | \begin{funcdesc}{cosh}{x} |
| 36 | Return the hyperbolic cosine of \var{x}. |
| 37 | \end{funcdesc} |
| 38 | |
| 39 | \begin{funcdesc}{exp}{x} |
| 40 | Return the exponential value $\mbox{e}^x$. |
| 41 | \end{funcdesc} |
| 42 | |
| 43 | \begin{funcdesc}{fabs}{x} |
| 44 | Return the absolute value of the real \var{x}. |
| 45 | \end{funcdesc} |
| 46 | |
| 47 | \begin{funcdesc}{floor}{x} |
| 48 | Return the floor of \var{x}. |
| 49 | \end{funcdesc} |
| 50 | |
| 51 | \begin{funcdesc}{fmod}{x, y} |
| 52 | Return \code{x \% y}. |
| 53 | \end{funcdesc} |
| 54 | |
| 55 | \begin{funcdesc}{frexp}{x} |
| 56 | Return the matissa and exponent for \var{x}. The mantissa is |
| 57 | positive. |
| 58 | \end{funcdesc} |
| 59 | |
| 60 | \begin{funcdesc}{hypot}{x, y} |
| 61 | Return the Euclidean distance, \code{sqrt(x*x + y*y)}. |
| 62 | \end{funcdesc} |
| 63 | |
| 64 | \begin{funcdesc}{ldexp}{x, i} |
| 65 | Return $x {\times} 2^i$. |
| 66 | \end{funcdesc} |
| 67 | |
| 68 | \begin{funcdesc}{modf}{x} |
| 69 | Return the fractional and integer parts of \var{x}. Both results |
| 70 | carry the sign of \var{x}. |
| 71 | \end{funcdesc} |
| 72 | |
| 73 | \begin{funcdesc}{pow}{x, y} |
| 74 | Return $x^y$. |
| 75 | \end{funcdesc} |
| 76 | |
| 77 | \begin{funcdesc}{sin}{x} |
| 78 | Return the sine of \var{x}. |
| 79 | \end{funcdesc} |
| 80 | |
| 81 | \begin{funcdesc}{sinh}{x} |
| 82 | Return the hyperbolic sine of \var{x}. |
| 83 | \end{funcdesc} |
| 84 | |
| 85 | \begin{funcdesc}{sqrt}{x} |
| 86 | Return the square root of \var{x}. |
| 87 | \end{funcdesc} |
| 88 | |
| 89 | \begin{funcdesc}{tan}{x} |
| 90 | Return the tangent of \var{x}. |
| 91 | \end{funcdesc} |
| 92 | |
| 93 | \begin{funcdesc}{tanh}{x} |
| 94 | Return the hyperbolic tangent of \var{x}. |
| 95 | \end{funcdesc} |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 96 | |
| 97 | Note that \code{frexp} and \code{modf} have a different call/return |
| 98 | pattern than their C equivalents: they take a single argument and |
| 99 | return a pair of values, rather than returning their second return |
| 100 | value through an `output parameter' (there is no such thing in Python). |
| 101 | |
Guido van Rossum | 5fdeeea | 1994-01-02 01:22:07 +0000 | [diff] [blame] | 102 | The module also defines two mathematical constants: |
Guido van Rossum | e47da0a | 1997-07-17 16:34:52 +0000 | [diff] [blame] | 103 | |
Fred Drake | b55e07f | 1997-09-30 21:59:27 +0000 | [diff] [blame] | 104 | \begin{datadesc}{pi} |
| 105 | The mathematical constant \emph{pi}. |
| 106 | \end{datadesc} |
| 107 | |
| 108 | \begin{datadesc}{e} |
| 109 | The mathematical constant \emph{e}. |
| 110 | \end{datadesc} |
| 111 | |
Fred Drake | 2950b2d | 1997-10-13 22:06:17 +0000 | [diff] [blame] | 112 | \begin{seealso} |
| 113 | \seemodule{cmath}{Complex number versions of many of these functions.} |
| 114 | \end{seealso} |