docs: clarify clip
behavior when arguments have different data types
#896
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR
clip
behavior is undefined whenmin
ormax
is outside the bounds ofx
#814 (comment) and Python scalars in elementwise functions #807 and supersedes feat!: allow clip to have int min or max when x is floating-point #811 to indicate that behavior is only defined whenmin
andmax
have the same data type asx
. After reviewing SciPy and scikit-learn usage ofxp.clip
andnp.clip
, the overwhelming usage was using scalarmin
andmax
. For all instances that I found with arraymin
andmax
, type promotion behavior was not expected. Given the various edge cases whenmin
andmax
are not the same type asx
, it seems prudent to limit portable behavior to the scenario which avoids edge cases altogether.clamp
as suggested in docs: clarify thatclip
behavior is undefined whenmin
ormax
is outside the bounds ofx
#814 (comment).min
and/ormax
are scalar values.