Skip to content

Update docstrings for bitwise functions #2359

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 4, 2025
Merged

Update docstrings for bitwise functions #2359

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f593e2f
Update docstrings in bitwise namespace
antonwolfy Mar 4, 2025
916ef9e
Update docstring of the file
antonwolfy Mar 4, 2025
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
15 changes: 14 additions & 1 deletion dpnp/dpnp_iface_bitwise.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
# *****************************************************************************

"""
Interface of the Binary operations of the DPNP
Interface of the Bitwise part of the DPNP

Notes
-----
Expand Down Expand Up @@ -84,6 +84,7 @@ def binary_repr(num, width=None):
at least a sufficient number of bits for `num` to be represented in the
designated form. If the `width` value is insufficient, an error is
raised.

Default: ``None``.

Returns
Expand Down Expand Up @@ -145,9 +146,11 @@ def binary_repr(num, width=None):
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.

Returns
Expand Down Expand Up @@ -232,9 +235,11 @@ def binary_repr(num, width=None):
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.

Returns
Expand Down Expand Up @@ -310,9 +315,11 @@ def binary_repr(num, width=None):
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.

Returns
Expand Down Expand Up @@ -386,9 +393,11 @@ def binary_repr(num, width=None):
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.

Returns
Expand Down Expand Up @@ -472,9 +481,11 @@ def binary_repr(num, width=None):
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.
Returns
-------
Expand Down Expand Up @@ -549,9 +560,11 @@ def binary_repr(num, width=None):
out : {None, dpnp.ndarray, usm_ndarray}, optional
Output array to populate.
Array must have the correct shape and the expected data type.

Default: ``None``.
order : {"C", "F", "A", "K"}, optional
Memory layout of the newly output array, if parameter `out` is ``None``.

Default: ``"K"``.

Returns
Expand Down
Loading