Mercurial > cpython-lru_cache-weakref
annotate Doc/lib/libmath.tex @ 28646:193b8aec00ce legacy-trunk
Changes from Jonathan Riehl to allow his pgen extension (PEP 269) to
work. This includes some more code that used to be part of pgen in
the main parser; I'm okay with that. I'll see if the Windows build
needs work next.
| author | Guido van Rossum <guido@python.org> |
|---|---|
| date | Thu, 17 Apr 2003 14:55:42 +0000 |
| parents | a9974a48a4d6 |
| children | b62d87816976 |
| rev | line source |
|---|---|
| 8918 | 1 \section{\module{math} --- |
| 10646 | 2 Mathematical functions} |
| 3 | |
|
8716
760dcf197048
Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents:
7877
diff
changeset
|
4 \declaremodule{builtin}{math} |
|
760dcf197048
Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents:
7877
diff
changeset
|
5 \modulesynopsis{Mathematical functions (\function{sin()} etc.).} |
|
760dcf197048
Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents:
7877
diff
changeset
|
6 |
| 10646 | 7 This module is always available. It provides access to the |
|
12223
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
8 mathematical functions defined by the C standard. |
|
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
9 |
|
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
10 These functions cannot be used with complex numbers; use the functions |
|
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
11 of the same name from the \refmodule{cmath} module if you require |
|
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
12 support for complex numbers. The distinction between functions which |
|
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
13 support complex numbers and those which don't is made since most users |
|
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
14 do not want to learn quite as much mathematics as required to |
|
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
15 understand complex numbers. Receiving an exception instead of a |
|
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
16 complex result allows earlier detection of the unexpected complex |
|
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
17 number used as a parameter, so that the programmer can determine how |
|
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
18 and why it was generated in the first place. |
|
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
19 |
|
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10646
diff
changeset
|
20 The following functions provided by this module: |
| 6363 | 21 |
|
1471
2ec96140a36b
Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff
changeset
|
22 \begin{funcdesc}{acos}{x} |
| 6363 | 23 Return the arc cosine of \var{x}. |
| 24 \end{funcdesc} | |
| 25 | |
| 26 \begin{funcdesc}{asin}{x} | |
| 27 Return the arc sine of \var{x}. | |
| 28 \end{funcdesc} | |
| 29 | |
| 30 \begin{funcdesc}{atan}{x} | |
| 31 Return the arc tangent of \var{x}. | |
| 32 \end{funcdesc} | |
| 33 | |
|
9607
8483953a9248
Rename the parameters of atan2(), based on comments from Guido & Peter
Fred Drake <fdrake@acm.org>
parents:
8918
diff
changeset
|
34 \begin{funcdesc}{atan2}{y, x} |
|
8483953a9248
Rename the parameters of atan2(), based on comments from Guido & Peter
Fred Drake <fdrake@acm.org>
parents:
8918
diff
changeset
|
35 Return \code{atan(\var{y} / \var{x})}. |
| 6363 | 36 \end{funcdesc} |
| 37 | |
| 38 \begin{funcdesc}{ceil}{x} | |
|
15602
e23d5b2e228c
Do not talk about "real" numbers; talk about "floats" or "floating point
Fred Drake <fdrake@acm.org>
parents:
14616
diff
changeset
|
39 Return the ceiling of \var{x} as a float. |
| 6363 | 40 \end{funcdesc} |
| 41 | |
| 42 \begin{funcdesc}{cos}{x} | |
| 43 Return the cosine of \var{x}. | |
| 44 \end{funcdesc} | |
| 45 | |
| 46 \begin{funcdesc}{cosh}{x} | |
| 47 Return the hyperbolic cosine of \var{x}. | |
| 48 \end{funcdesc} | |
| 49 | |
|
23425
62403b93f470
Added degrees() and radians() to mathmodule. Closing patch 552452 and
Raymond Hettinger <python@rcn.com>
parents:
15602
diff
changeset
|
50 \begin{funcdesc}{degrees}{x} |
|
62403b93f470
Added degrees() and radians() to mathmodule. Closing patch 552452 and
Raymond Hettinger <python@rcn.com>
parents:
15602
diff
changeset
|
51 Converts angle \var{x} from radians to degrees. |
|
62403b93f470
Added degrees() and radians() to mathmodule. Closing patch 552452 and
Raymond Hettinger <python@rcn.com>
parents:
15602
diff
changeset
|
52 \end{funcdesc} |
|
62403b93f470
Added degrees() and radians() to mathmodule. Closing patch 552452 and
Raymond Hettinger <python@rcn.com>
parents:
15602
diff
changeset
|
53 |
| 6363 | 54 \begin{funcdesc}{exp}{x} |
|
6647
a7ea74a27993
Get rid of math mode in some places.
Guido van Rossum <guido@python.org>
parents:
6485
diff
changeset
|
55 Return \code{e**\var{x}}. |
| 6363 | 56 \end{funcdesc} |
| 57 | |
| 58 \begin{funcdesc}{fabs}{x} | |
|
15602
e23d5b2e228c
Do not talk about "real" numbers; talk about "floats" or "floating point
Fred Drake <fdrake@acm.org>
parents:
14616
diff
changeset
|
59 Return the absolute value of the floating point number \var{x}. |
| 6363 | 60 \end{funcdesc} |
| 61 | |
| 62 \begin{funcdesc}{floor}{x} | |
|
15602
e23d5b2e228c
Do not talk about "real" numbers; talk about "floats" or "floating point
Fred Drake <fdrake@acm.org>
parents:
14616
diff
changeset
|
63 Return the floor of \var{x} as a float. |
|
1471
2ec96140a36b
Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff
changeset
|
64 \end{funcdesc} |
| 6363 | 65 |
| 66 \begin{funcdesc}{fmod}{x, y} | |
|
14616
284508c653c7
Fixed legit gripe from c.l.py that math.fmod docs aren't confusing enough.
Tim Peters <tim.peters@gmail.com>
parents:
13912
diff
changeset
|
67 Return \code{fmod(\var{x}, \var{y})}, as defined by the platform C library. |
|
284508c653c7
Fixed legit gripe from c.l.py that math.fmod docs aren't confusing enough.
Tim Peters <tim.peters@gmail.com>
parents:
13912
diff
changeset
|
68 Note that the Python expression \code{\var{x} \%\ \var{y}} may not return |
|
284508c653c7
Fixed legit gripe from c.l.py that math.fmod docs aren't confusing enough.
Tim Peters <tim.peters@gmail.com>
parents:
13912
diff
changeset
|
69 the same result. |
| 6363 | 70 \end{funcdesc} |
| 71 | |
| 72 \begin{funcdesc}{frexp}{x} | |
|
13314
03aa26819ac2
Tim-blessed documentation for math.frexp().
Fred Drake <fdrake@acm.org>
parents:
12714
diff
changeset
|
73 % Blessed by Tim. |
|
03aa26819ac2
Tim-blessed documentation for math.frexp().
Fred Drake <fdrake@acm.org>
parents:
12714
diff
changeset
|
74 Return the mantissa and exponent of \var{x} as the pair |
|
03aa26819ac2
Tim-blessed documentation for math.frexp().
Fred Drake <fdrake@acm.org>
parents:
12714
diff
changeset
|
75 \code{(\var{m}, \var{e})}. \var{m} is a float and \var{e} is an |
|
03aa26819ac2
Tim-blessed documentation for math.frexp().
Fred Drake <fdrake@acm.org>
parents:
12714
diff
changeset
|
76 integer such that \code{\var{x} == \var{m} * 2**\var{e}}. |
|
03aa26819ac2
Tim-blessed documentation for math.frexp().
Fred Drake <fdrake@acm.org>
parents:
12714
diff
changeset
|
77 If \var{x} is zero, returns \code{(0.0, 0)}, otherwise |
|
03aa26819ac2
Tim-blessed documentation for math.frexp().
Fred Drake <fdrake@acm.org>
parents:
12714
diff
changeset
|
78 \code{0.5 <= abs(\var{m}) < 1}. |
| 6363 | 79 \end{funcdesc} |
| 80 | |
| 81 \begin{funcdesc}{hypot}{x, y} | |
|
7048
3eca5f37501a
Typographical nits: Always set parameter names in \var{} in the running text.
Fred Drake <fdrake@acm.org>
parents:
6647
diff
changeset
|
82 Return the Euclidean distance, \code{sqrt(\var{x}*\var{x} + \var{y}*\var{y})}. |
| 6363 | 83 \end{funcdesc} |
| 84 | |
| 85 \begin{funcdesc}{ldexp}{x, i} | |
|
6647
a7ea74a27993
Get rid of math mode in some places.
Guido van Rossum <guido@python.org>
parents:
6485
diff
changeset
|
86 Return \code{\var{x} * (2**\var{i})}. |
| 6363 | 87 \end{funcdesc} |
| 88 | |
|
26661
b12e326b4ea2
Apply SF patch 652930: Add optional base argument to math.log(x[, base]).
Raymond Hettinger <python@rcn.com>
parents:
23425
diff
changeset
|
89 \begin{funcdesc}{log}{x\optional{, base}} |
|
26684
a9974a48a4d6
Add markup for base parameter
Neal Norwitz <nnorwitz@gmail.com>
parents:
26661
diff
changeset
|
90 Returns the logarithm of \var{x} to the given \var{base}. |
|
a9974a48a4d6
Add markup for base parameter
Neal Norwitz <nnorwitz@gmail.com>
parents:
26661
diff
changeset
|
91 If the \var{base} is not specified, returns the natural logarithm of \var{x}. |
|
26661
b12e326b4ea2
Apply SF patch 652930: Add optional base argument to math.log(x[, base]).
Raymond Hettinger <python@rcn.com>
parents:
23425
diff
changeset
|
92 \versionchanged[\var{base} argument added]{2.3} |
|
7157
a6fa9f3cad13
Added descriptions for log() and log10().
Fred Drake <fdrake@acm.org>
parents:
7048
diff
changeset
|
93 \end{funcdesc} |
|
a6fa9f3cad13
Added descriptions for log() and log10().
Fred Drake <fdrake@acm.org>
parents:
7048
diff
changeset
|
94 |
|
a6fa9f3cad13
Added descriptions for log() and log10().
Fred Drake <fdrake@acm.org>
parents:
7048
diff
changeset
|
95 \begin{funcdesc}{log10}{x} |
|
a6fa9f3cad13
Added descriptions for log() and log10().
Fred Drake <fdrake@acm.org>
parents:
7048
diff
changeset
|
96 Return the base-10 logarithm of \var{x}. |
|
a6fa9f3cad13
Added descriptions for log() and log10().
Fred Drake <fdrake@acm.org>
parents:
7048
diff
changeset
|
97 \end{funcdesc} |
|
a6fa9f3cad13
Added descriptions for log() and log10().
Fred Drake <fdrake@acm.org>
parents:
7048
diff
changeset
|
98 |
| 6363 | 99 \begin{funcdesc}{modf}{x} |
| 100 Return the fractional and integer parts of \var{x}. Both results | |
|
15602
e23d5b2e228c
Do not talk about "real" numbers; talk about "floats" or "floating point
Fred Drake <fdrake@acm.org>
parents:
14616
diff
changeset
|
101 carry the sign of \var{x}. The integer part is returned as a float. |
| 6363 | 102 \end{funcdesc} |
| 103 | |
| 104 \begin{funcdesc}{pow}{x, y} | |
|
6647
a7ea74a27993
Get rid of math mode in some places.
Guido van Rossum <guido@python.org>
parents:
6485
diff
changeset
|
105 Return \code{\var{x}**\var{y}}. |
| 6363 | 106 \end{funcdesc} |
| 107 | |
|
23425
62403b93f470
Added degrees() and radians() to mathmodule. Closing patch 552452 and
Raymond Hettinger <python@rcn.com>
parents:
15602
diff
changeset
|
108 \begin{funcdesc}{radians}{x} |
|
62403b93f470
Added degrees() and radians() to mathmodule. Closing patch 552452 and
Raymond Hettinger <python@rcn.com>
parents:
15602
diff
changeset
|
109 Converts angle \var{x} from degrees to radians. |
|
62403b93f470
Added degrees() and radians() to mathmodule. Closing patch 552452 and
Raymond Hettinger <python@rcn.com>
parents:
15602
diff
changeset
|
110 \end{funcdesc} |
|
62403b93f470
Added degrees() and radians() to mathmodule. Closing patch 552452 and
Raymond Hettinger <python@rcn.com>
parents:
15602
diff
changeset
|
111 |
| 6363 | 112 \begin{funcdesc}{sin}{x} |
| 113 Return the sine of \var{x}. | |
| 114 \end{funcdesc} | |
| 115 | |
| 116 \begin{funcdesc}{sinh}{x} | |
| 117 Return the hyperbolic sine of \var{x}. | |
| 118 \end{funcdesc} | |
| 119 | |
| 120 \begin{funcdesc}{sqrt}{x} | |
| 121 Return the square root of \var{x}. | |
| 122 \end{funcdesc} | |
| 123 | |
| 124 \begin{funcdesc}{tan}{x} | |
| 125 Return the tangent of \var{x}. | |
| 126 \end{funcdesc} | |
| 127 | |
| 128 \begin{funcdesc}{tanh}{x} | |
| 129 Return the hyperbolic tangent of \var{x}. | |
| 130 \end{funcdesc} | |
|
1471
2ec96140a36b
Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff
changeset
|
131 |
|
7157
a6fa9f3cad13
Added descriptions for log() and log10().
Fred Drake <fdrake@acm.org>
parents:
7048
diff
changeset
|
132 Note that \function{frexp()} and \function{modf()} have a different |
| 10646 | 133 call/return pattern than their C equivalents: they take a single |
|
7157
a6fa9f3cad13
Added descriptions for log() and log10().
Fred Drake <fdrake@acm.org>
parents:
7048
diff
changeset
|
134 argument and return a pair of values, rather than returning their |
|
a6fa9f3cad13
Added descriptions for log() and log10().
Fred Drake <fdrake@acm.org>
parents:
7048
diff
changeset
|
135 second return value through an `output parameter' (there is no such |
|
a6fa9f3cad13
Added descriptions for log() and log10().
Fred Drake <fdrake@acm.org>
parents:
7048
diff
changeset
|
136 thing in Python). |
|
1471
2ec96140a36b
Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff
changeset
|
137 |
|
2ec96140a36b
Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff
changeset
|
138 The module also defines two mathematical constants: |
| 6363 | 139 |
|
1471
2ec96140a36b
Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff
changeset
|
140 \begin{datadesc}{pi} |
| 6363 | 141 The mathematical constant \emph{pi}. |
|
1471
2ec96140a36b
Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff
changeset
|
142 \end{datadesc} |
| 5818 | 143 |
| 6363 | 144 \begin{datadesc}{e} |
| 145 The mathematical constant \emph{e}. | |
| 146 \end{datadesc} | |
| 147 | |
|
6485
2f258162aae2
Restore the \seealso formatting that got lost when I updated the math
Fred Drake <fdrake@acm.org>
parents:
6363
diff
changeset
|
148 \begin{seealso} |
|
2f258162aae2
Restore the \seealso formatting that got lost when I updated the math
Fred Drake <fdrake@acm.org>
parents:
6363
diff
changeset
|
149 \seemodule{cmath}{Complex number versions of many of these functions.} |
|
2f258162aae2
Restore the \seealso formatting that got lost when I updated the math
Fred Drake <fdrake@acm.org>
parents:
6363
diff
changeset
|
150 \end{seealso} |