cpython/Doc/libmath.tex

115 lines
2.5 KiB
TeX
Raw Normal View History

1994-01-02 01:22:07 +00:00
\section{Built-in Module \sectcode{math}}
\label{module-math}
1994-01-02 01:22:07 +00:00
\bimodindex{math}
\renewcommand{\indexsubitem}{(in module math)}
This module is always available.
It provides access to the mathematical functions defined by the C
standard.
They are:
1997-09-30 21:59:27 +00:00
1994-01-02 01:22:07 +00:00
\begin{funcdesc}{acos}{x}
1997-09-30 21:59:27 +00:00
Return the arc cosine of \var{x}.
\end{funcdesc}
\begin{funcdesc}{asin}{x}
Return the arc sine of \var{x}.
\end{funcdesc}
\begin{funcdesc}{atan}{x}
Return the arc tangent of \var{x}.
\end{funcdesc}
\begin{funcdesc}{atan2}{x, y}
Return \code{atan(x / y)}.
\end{funcdesc}
\begin{funcdesc}{ceil}{x}
Return the ceiling of \var{x}.
\end{funcdesc}
\begin{funcdesc}{cos}{x}
Return the cosine of \var{x}.
\end{funcdesc}
\begin{funcdesc}{cosh}{x}
Return the hyperbolic cosine of \var{x}.
\end{funcdesc}
\begin{funcdesc}{exp}{x}
1997-11-25 01:00:40 +00:00
Return \code{e**\var{x}}.
1997-09-30 21:59:27 +00:00
\end{funcdesc}
\begin{funcdesc}{fabs}{x}
Return the absolute value of the real \var{x}.
\end{funcdesc}
\begin{funcdesc}{floor}{x}
Return the floor of \var{x}.
\end{funcdesc}
\begin{funcdesc}{fmod}{x, y}
Return \code{x \% y}.
\end{funcdesc}
\begin{funcdesc}{frexp}{x}
Return the matissa and exponent for \var{x}. The mantissa is
positive.
\end{funcdesc}
\begin{funcdesc}{hypot}{x, y}
Return the Euclidean distance, \code{sqrt(x*x + y*y)}.
\end{funcdesc}
\begin{funcdesc}{ldexp}{x, i}
1997-11-25 01:00:40 +00:00
Return \code{\var{x} * (2**\var{i})}.
1997-09-30 21:59:27 +00:00
\end{funcdesc}
\begin{funcdesc}{modf}{x}
Return the fractional and integer parts of \var{x}. Both results
carry the sign of \var{x}.
\end{funcdesc}
\begin{funcdesc}{pow}{x, y}
1997-11-25 01:00:40 +00:00
Return \code{\var{x}**\var{y}}.
1997-09-30 21:59:27 +00:00
\end{funcdesc}
\begin{funcdesc}{sin}{x}
Return the sine of \var{x}.
\end{funcdesc}
\begin{funcdesc}{sinh}{x}
Return the hyperbolic sine of \var{x}.
\end{funcdesc}
\begin{funcdesc}{sqrt}{x}
Return the square root of \var{x}.
\end{funcdesc}
\begin{funcdesc}{tan}{x}
Return the tangent of \var{x}.
\end{funcdesc}
\begin{funcdesc}{tanh}{x}
Return the hyperbolic tangent of \var{x}.
\end{funcdesc}
1994-01-02 01:22:07 +00:00
Note that \code{frexp} and \code{modf} have a different call/return
pattern 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 parameter' (there is no such thing in Python).
The module also defines two mathematical constants:
1997-09-30 21:59:27 +00:00
1994-01-02 01:22:07 +00:00
\begin{datadesc}{pi}
1997-09-30 21:59:27 +00:00
The mathematical constant \emph{pi}.
\end{datadesc}
\begin{datadesc}{e}
The mathematical constant \emph{e}.
1994-01-02 01:22:07 +00:00
\end{datadesc}
\begin{seealso}
\seemodule{cmath}{Complex number versions of many of these functions.}
\end{seealso}