]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Tim-blessed documentation for math.frexp().
authorFred Drake <fdrake@acm.org>
Mon, 3 Jul 2000 06:38:17 +0000 (06:38 +0000)
committerFred Drake <fdrake@acm.org>
Mon, 3 Jul 2000 06:38:17 +0000 (06:38 +0000)
Doc/lib/libmath.tex

index bf0a1afd592ca29f5e9a74e0b0f9f687d9e86e3b..d057e862c525b8c6a0a2bfe49c452c6b542fc37e 100644 (file)
@@ -64,12 +64,12 @@ Return \code{\var{x} \%\ \var{y}}.
 \end{funcdesc}
 
 \begin{funcdesc}{frexp}{x}
-Convert a floating-point number to fractional and integral
-components.  If \var{x} is zero, returns \code{(0.0, 0)}, otherwise
-returns \code{(\var{frac}, \var{exp})} such that \code{\var{frac} *
-2**\var{exp}} will equal \var{x}.  \var{exp} will be an integer, and
-the absolute value of \var{frac} will be in the range [0.5, 1.0)
-(\var{frac} will share the sign of \var{x}).
+% Blessed by Tim.
+Return the mantissa and exponent of \var{x} as the pair
+\code{(\var{m}, \var{e})}.  \var{m} is a float and \var{e} is an
+integer such that \code{\var{x} == \var{m} * 2**\var{e}}.
+If \var{x} is zero, returns \code{(0.0, 0)}, otherwise
+\code{0.5 <= abs(\var{m}) < 1}.
 \end{funcdesc}
 
 \begin{funcdesc}{hypot}{x, y}