diff options
author | Peter Andreas Entschev <peter@entschev.com> | 2020-08-19 09:41:38 -0700 |
---|---|---|
committer | Peter Andreas Entschev <peter@entschev.com> | 2020-08-19 09:41:38 -0700 |
commit | a82cc4b5cb4c3926d2b555d9e8da1146c472a17c (patch) | |
tree | 9bf4074335a0e57e4230becec44be4a1b49513a0 /doc | |
parent | 101700710dbe5bdfa891d43f1fc14fb6439082ea (diff) | |
download | numpy-a82cc4b5cb4c3926d2b555d9e8da1146c472a17c.tar.gz |
NEP: Move NumPy users comment to top of NEP-35 Usage and Impact
Diffstat (limited to 'doc')
-rw-r--r-- | doc/neps/nep-0035-array-creation-dispatch-with-array-function.rst | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/neps/nep-0035-array-creation-dispatch-with-array-function.rst b/doc/neps/nep-0035-array-creation-dispatch-with-array-function.rst index d783df5b0..9fb117005 100644 --- a/doc/neps/nep-0035-array-creation-dispatch-with-array-function.rst +++ b/doc/neps/nep-0035-array-creation-dispatch-with-array-function.rst @@ -87,6 +87,12 @@ of the keyword-only argument standard described in PEP-3102 [2]_ to implement Usage and Impact ---------------- +NumPy users who don't use other arrays from downstream libraries can continue +to use array creation routines without a ``like=`` argument. Using +``like=np.ndarray`` will work as if no array was passed via that argument. +However, this will incur additional checks that will negatively impact +performance. + To understand the intended use for ``like=``, and before we move to more complex cases, consider the following illustrative example consisting only of NumPy and CuPy arrays: @@ -163,13 +169,6 @@ impossible to ensure ``my_pad`` creates a padding array with a type matching that of the input array, which would cause a ``TypeError`` exception to be raised by CuPy, as discussed above would happen to the CuPy case alone. -Current NumPy users who don't use other arrays from downstream libraries should -have no impact in their current usage of the NumPy API. In the event of the -user passing a NumPy array to ``like=``, that will continue to work as if no -array was passed via that argument. However, this is advised against, as -internally there will be additional checks required that will have an impact in -performance. - Backward Compatibility ---------------------- |