summaryrefslogtreecommitdiff
path: root/numpy/lib/scimath.py
diff options
context:
space:
mode:
authorrgommers <ralf.gommers@googlemail.com>2010-07-31 10:04:38 +0000
committerrgommers <ralf.gommers@googlemail.com>2010-07-31 10:04:38 +0000
commitd0a25f19139a2987af5a4e2d1ebf4badb2802c16 (patch)
tree3d7218398060ce0c4f9d9d37241764fd57a8314a /numpy/lib/scimath.py
parentc38c9d4cd338cc147b67f1f160d69ab7ef0df097 (diff)
downloadnumpy-d0a25f19139a2987af5a4e2d1ebf4badb2802c16.tar.gz
DOC: wiki merge, twodim_base and a few loose ones.
Diffstat (limited to 'numpy/lib/scimath.py')
-rw-r--r--numpy/lib/scimath.py15
1 files changed, 8 insertions, 7 deletions
diff --git a/numpy/lib/scimath.py b/numpy/lib/scimath.py
index 57cf92aaa..48ed1dc25 100644
--- a/numpy/lib/scimath.py
+++ b/numpy/lib/scimath.py
@@ -3,16 +3,17 @@ Wrapper functions to more user-friendly calling of certain math functions
whose output data-type is different than the input data-type in certain
domains of the input.
-For example, for functions like log() with branch cuts, the versions in this
-module provide the mathematically valid answers in the complex plane:
+For example, for functions like `log` with branch cuts, the versions in this
+module provide the mathematically valid answers in the complex plane::
->>> import math
->>> from numpy.lib import scimath
->>> scimath.log(-math.exp(1)) == (1+1j*math.pi)
-True
+ >>> import math
+ >>> from numpy.lib import scimath
+ >>> scimath.log(-math.exp(1)) == (1+1j*math.pi)
+ True
-Similarly, sqrt(), other base logarithms, power() and trig functions are
+Similarly, `sqrt`, other base logarithms, `power` and trig functions are
correctly handled. See their respective docstrings for specific examples.
+
"""
__all__ = ['sqrt', 'log', 'log2', 'logn','log10', 'power', 'arccos',