diff options
Diffstat (limited to 'numpy/lib/scimath.py')
| -rw-r--r-- | numpy/lib/scimath.py | 15 |
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', |