Skip to content
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.

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

ENH: harmonize rules for how NEP 18 functions handle an *out* argument #295

Merged
merged 1 commit into from
Oct 14, 2022
Merged
Changes from all commits
Commits
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
60 changes: 43 additions & 17 deletions unyt/_array_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ def dot(a, b, out=None):
conv_factor = _get_conversion_factor(out, prod_units)

np.dot._implementation(a.ndview, b.ndview, out=out.ndview)
if not out.units == prod_units:
if out.units != prod_units:
out[:] *= conv_factor
return out

Expand All @@ -69,7 +69,7 @@ def outer(a, b, out=None):
conv_factor = _get_conversion_factor(out, prod_units)

np.outer._implementation(a.ndview, b.ndview, out=out.ndview)
if not out.units == prod_units:
if out.units != prod_units:
out[:] *= conv_factor
return out

Expand All @@ -87,7 +87,7 @@ def matmul(a, b, out=None, **kwargs):

conv_factor = _get_conversion_factor(out, prod_units)
np.matmul._implementation(a.ndview, b.ndview, out=out.ndview)
if not out.units == prod_units:
if out.units != prod_units:
out[:] *= conv_factor
return out

Expand Down Expand Up @@ -203,17 +203,37 @@ def _validate_units_consistency(arrs):
@implements(np.concatenate)
def concatenate(arrs, /, axis=0, out=None, dtype=None, casting="same_kind"):
_validate_units_consistency(arrs)
if NUMPY_VERSION >= Version("1.20"):
v = np.concatenate._implementation(
[_.ndview for _ in arrs], axis=axis, out=out, dtype=dtype, casting=casting
)
ret_units = arrs[0].units
if out is None:
if NUMPY_VERSION >= Version("1.20"):
v = np.concatenate._implementation(
[_.ndview for _ in arrs], axis=axis, dtype=dtype, casting=casting
)
else:
v = np.concatenate._implementation(
[_.ndview for _ in arrs],
axis=axis,
)
out = v * ret_units
else:
v = np.concatenate._implementation(
[_.ndview for _ in arrs],
axis=axis,
out=out,
)
return v * arrs[0].units
cf = _get_conversion_factor(out, ret_units)
if NUMPY_VERSION >= Version("1.20"):
np.concatenate._implementation(
[_.ndview for _ in arrs],
axis=axis,
out=out.ndview,
dtype=dtype,
casting=casting,
)
else:
np.concatenate._implementation(
[_.ndview for _ in arrs],
axis=axis,
out=out.ndview,
)
if out.units != ret_units:
out[:] *= cf
return out


@implements(np.cross)
Expand Down Expand Up @@ -271,7 +291,13 @@ def hstack(tup, /):
@implements(np.stack)
def stack(arrays, /, axis=0, out=None):
_validate_units_consistency(arrays)
return (
np.stack._implementation([_.ndview for _ in arrays], axis=axis, out=out)
* arrays[0].units
)
ret_units = arrays[0].units
if out is None:
return (
np.stack._implementation([_.ndview for _ in arrays], axis=axis) * ret_units
)
cf = _get_conversion_factor(out, ret_units)
np.stack._implementation([_.ndview for _ in arrays], axis=axis, out=out.ndview)
if out.units != ret_units:
out[:] *= cf
return out