8000 DOC: Add take_along_axis to the see also section in argmin, argmax etc. by mproszewska · Pull Request #14799 · numpy/numpy · GitHub
[go: up one dir, main page]
Skip to content
/ numpy Public

DOC: Add take_along_axis to the see also section in argmin, argmax etc. #14799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Nov 4, 2019
Merged

DOC: Add take_along_axis to the see also section in argmin, argmax etc. #14799

Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
fbf8ae4
Add take_along_axis to the see also section in argmin, argmax, argsor…
mproszewska Oct 29, 2019
020d3f2
Change description of method and add examples.
mproszewska Oct 31, 2019
508d384
Better argpartition example.
mproszewska Nov 1, 2019
bc132a1
Update numpy/core/fromnumeric.py
mproszewska Nov 1, 2019
728dfeb
Update numpy/core/fromnumeric.py
mproszewska Nov 1, 2019
c2a6792
Update numpy/core/fromnumeric.py
mproszewska Nov 1, 2019
b4d0800
Update numpy/core/fromnumeric.py
mproszewska Nov 2, 2019
af2c10e
Update numpy/core/fromnumeric.py
mproszewska Nov 2, 2019
de02cd9
Update numpy/core/fromnumeric.py
mproszewska Nov 2, 2019
7b39d15
Update numpy/core/fromnumeric.py
mproszewska Nov 2, 2019
e21bf0f
Fix syntax in examples.
mproszewska Nov 3, 2019
1086adc
Fix syntax in argpartition the see also section.
mproszewska Nov 3, 2019
4578aa8
Fix spaces.
mproszewska Nov 3, 2019
d7e3d85
Merge branch 'master' into doc-take-along-axis
mproszewska Nov 3, 2019
a292393
Fix tabs.
mproszewska Nov 3, 2019
12c0475
Fix spaces before comments.
mproszewska Nov 3, 2019
fe33b8d
Move comments above command.
mproszewska Nov 3, 2019
66ccd51
Split lines.
mproszewska Nov 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 37 additions & 1 deletion numpy/core/fromnumeric.py
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
Expand Up @@ -796,7 +796,9 @@ def argpartition(a, kth, axis=-1, kind='introselect', order=None):
--------
partition : Describes partition algorithms used.
ndarray.partition : Inplace partition.
argsort : Full indirect sort
argsort : Full indirect sort.
take_along_axis : Apply ``index_array`` from argpartition
to an array as if by calling partition.

Notes
-----
Expand All @@ -816,6 +818,14 @@ def argpartition(a, kth, axis=-1, kind='introselect', order=None):
>>> np.array(x)[np.argpartition(x, 3)]
array([2, 1, 3, 4])

Multi-dimensional array:

>>> x = np.array([[3, 4, 2], [1, 3, 1]])
>>> index_array = np.argpartition(x, kth=1, axis=-1)
>>> np.take_along_axis(x, index_array, axis=-1) # same as np.partition(x, kth=1)
array([[2, 3, 4],
[1, 1, 3]])

"""
return _wrapfunc(a, 'argpartition', kth, axis=axis, kind=kind, order=order)

Expand Down Expand Up @@ -1025,6 +1035,8 @@ def argsort(a, axis=-1, kind=None, order=None):
lexsort : Indirect stable sort with multiple keys.
ndarray.sort : Inplace sort.
argpartition : Indirect partial sort.
take_along_axis : Apply ``index_array`` from argsort
to an array as if by calling sort.

Notes
-----
Expand Down Expand Up @@ -1120,6 +1132,8 @@ def argmax(a, axis=None, out=None):
ndarray.argmax, argmin
amax : The maximum value along a given axis.
unravel_index : Convert a flat index into an index tuple.
take_along_axis : Apply ``np.expand_dims(index_array, axis)``
from argmax to an array as if by calling max.

Notes
-----
Expand Down Expand Up @@ -1154,6 +1168,16 @@ def argmax(a, axis=None, out=None):
>>> np.argmax(b) # Only the first occurrence is returned.
1

>>> x = np.array([[4,2,3], [1,0,3]])
>>> index_array = np.argmax(x, axis=-1)
>>> # Same as np.max(x, axis=-1, keepdims=True)
>>> np.take_along_axis(x, np.expand_dims(index_array, axis=-1), axis=-1)
array([[4],
[3]])
>>> # Same as np.max(x, axis=-1)
>>> np.take_along_axis(x, np.expand_dims(index_array, axis=-1), axis=-1).squeeze(axis=-1)
array([4, 3])

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These lines are quite long. Maybe move the comment to stand alone in the line above the code

"""
return _wrapfunc(a, 'argmax', axis=axis, out=out)

Expand Down Expand Up @@ -1189,6 +1213,8 @@ def argmin(a, axis=None, out=None):
ndarray.argmin, argmax
amin : The minimum value along a given axis.
unravel_index : Convert a flat index into an index tuple.
take_along_axis : Apply ``np.expand_dims(index_array, axis)``
from argmin to an array as if by calling min.

Notes
-----
Expand Down Expand Up @@ -1223,6 +1249,16 @@ def argmin(a, axis=None, out=None):
>>> np.argmin(b) # Only the first occurrence is returned.
0

>>> x = np.array([[4,2,3], [1,0,3]])
>>> index_array = np.argmin(x, axis=-1)
>>> # Same as np.min(x, axis=-1, keepdims=True)
>>> np.take_along_axis(x, np.expand_dims(index_array, axis=-1), axis=-1)
array([[2],
[0]])
>>> # Same as np.max(x, axis=-1)
>>> np.take_along_axis(x, np.expand_dims(index_array, axis=-1), axis=-1).squeeze(axis=-1)
array([2, 0])

"""
return _wrapfunc(a, 'argmin', axis=axis, out=out)

Expand Down
0