Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 50da92a

Browse files
committed
Merge pull request #4400 from charris/fix-ufunc-documention
Fix ufunc documention
2 parents 64e9f78 + 6bfd6d4 commit 50da92a

3 files changed

Lines changed: 364 additions & 252 deletions

File tree

numpy/add_newdocs.py

Lines changed: 0 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -4693,45 +4693,6 @@ def luf(lamdaexpr, *args, **kwargs):
46934693
#
46944694
##############################################################################
46954695

4696-
add_newdoc('numpy.core.umath', 'frexp',
4697-
"""
4698-
Return normalized fraction and exponent of 2 of input array, element-wise.
4699-
4700-
Returns (`out1`, `out2`) from equation ``x` = out1 * 2**out2``.
4701-
4702-
Parameters
4703-
----------
4704-
x : array_like
4705-
Input array.
4706-
4707-
Returns
4708-
-------
4709-
(out1, out2) : tuple of ndarrays, (float, int)
4710-
`out1` is a float array with values between -1 and 1.
4711-
`out2` is an int array which represent the exponent of 2.
4712-
4713-
See Also
4714-
--------
4715-
ldexp : Compute ``y = x1 * 2**x2``, the inverse of `frexp`.
4716-
4717-
Notes
4718-
-----
4719-
Complex dtypes are not supported, they will raise a TypeError.
4720-
4721-
Examples
4722-
--------
4723-
>>> x = np.arange(9)
4724-
>>> y1, y2 = np.frexp(x)
4725-
>>> y1
4726-
array([ 0. , 0.5 , 0.5 , 0.75 , 0.5 , 0.625, 0.75 , 0.875,
4727-
0.5 ])
4728-
>>> y2
4729-
array([0, 1, 2, 2, 3, 3, 3, 3, 4])
4730-
>>> y1 * 2**y2
4731-
array([ 0., 1., 2., 3., 4., 5., 6., 7., 8.])
4732-
4733-
""")
4734-
47354696
add_newdoc('numpy.core.umath', 'frompyfunc',
47364697
"""
47374698
frompyfunc(func, nin, nout)
@@ -4772,44 +4733,6 @@ def luf(lamdaexpr, *args, **kwargs):
47724733
47734734
""")
47744735

4775-
add_newdoc('numpy.core.umath', 'ldexp',
4776-
"""
4777-
Compute y = x1 * 2**x2.
4778-
4779-
Parameters
4780-
----------
4781-
x1 : array_like
4782-
The array of multipliers.
4783-
x2 : array_like
4784-
The array of exponents.
4785-
4786-
Returns
4787-
-------
4788-
y : array_like
4789-
The output array, the result of ``x1 * 2**x2``.
4790-
4791-
See Also
4792-
--------
4793-
frexp : Return (y1, y2) from ``x = y1 * 2**y2``, the inverse of `ldexp`.
4794-
4795-
Notes
4796-
-----
4797-
Complex dtypes are not supported, they will raise a TypeError.
4798-
4799-
`ldexp` is useful as the inverse of `frexp`, if used by itself it is
4800-
more clear to simply use the expression ``x1 * 2**x2``.
4801-
4802-
Examples
4803-
--------
4804-
>>> np.ldexp(5, np.arange(4))
4805-
array([ 5., 10., 20., 40.], dtype=float32)
4806-
4807-
>>> x = np.arange(6)
4808-
>>> np.ldexp(*np.frexp(x))
4809-
array([ 0., 1., 2., 3., 4., 5.])
4810-
4811-
""")
4812-
48134736
add_newdoc('numpy.core.umath', 'geterrobj',
48144737
"""
48154738
geterrobj()

0 commit comments

Comments
 (0)