diff options
| author | pezcore <pezcore@users.noreply.github.com> | 2017-02-03 11:51:00 -0500 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2017-02-03 09:51:00 -0700 |
| commit | eefc4b8bea043a324927e40d998ed760799f0b82 (patch) | |
| tree | efc52e174292f78bc3130572d28a932b1d70de98 /numpy/core/fromnumeric.py | |
| parent | 2aa36e94e9f683afdf9ec015c41f94be3bd4b38a (diff) | |
| download | numpy-eefc4b8bea043a324927e40d998ed760799f0b82.tar.gz | |
8552 doc clip none (#8558)
* documenting behaviour of passing `None` to upper or lower interval bounds in `clip()`
* doc: specifying that not more than one of formal parameters `a_min` and `a_max` may be none
Diffstat (limited to 'numpy/core/fromnumeric.py')
| -rw-r--r-- | numpy/core/fromnumeric.py | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index a2159405c..58f8696d2 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -1667,11 +1667,15 @@ def clip(a, a_min, a_max, out=None): ---------- a : array_like Array containing elements to clip. - a_min : scalar or array_like - Minimum value. - a_max : scalar or array_like - Maximum value. If `a_min` or `a_max` are array_like, then the - three arrays will be broadcasted to match their shapes. + a_min : scalar or array_like or `None` + Minimum value. If `None`, clipping is not performed on lower + interval edge. Not more than one of `a_min` and `a_max` may be + `None`. + a_max : scalar or array_like or `None` + Maximum value. If `None`, clipping is not performed on upper + interval edge. Not more than one of `a_min` and `a_max` may be + `None`. If `a_min` or `a_max` are array_like, then the three + arrays will be broadcasted to match their shapes. out : ndarray, optional The results will be placed in this array. It may be the input array for in-place clipping. `out` must be of the right shape |