summaryrefslogtreecommitdiff
path: root/numpy/core/fromnumeric.py
diff options
context:
space:
mode:
authorRyan Soklaski <ry26099@mit.edu>2020-02-16 12:35:41 -0500
committerRyan Soklaski <ry26099@mit.edu>2020-02-16 12:35:41 -0500
commit1d0033d09a29f5be76e8a8a8eec2278fb89eac17 (patch)
tree874d604e9c8fea8d2829739f6252c66a19050535 /numpy/core/fromnumeric.py
parentcd02ddc9c0ea2b7f5f879c0564709eabcec6f1af (diff)
downloadnumpy-1d0033d09a29f5be76e8a8a8eec2278fb89eac17.tar.gz
DOC: numpy.clip is equivalent to minimum(..., maximum(...))
Diffstat (limited to 'numpy/core/fromnumeric.py')
-rw-r--r--numpy/core/fromnumeric.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py
index ab45ddfe8..acd2d2bea 100644
--- a/numpy/core/fromnumeric.py
+++ b/numpy/core/fromnumeric.py
@@ -2039,8 +2039,8 @@ def clip(a, a_min, a_max, out=None, **kwargs):
is specified, values smaller than 0 become 0, and values larger
than 1 become 1.
- Equivalent to but faster than ``np.maximum(a_min, np.minimum(a, a_max))``
- assuming ``a_min < a_max``.
+ Equivalent to but faster than ``np.minimum(a_max, np.maximum(a, a_min))``.
+
No check is performed to ensure ``a_min < a_max``.
Parameters