-
Notifications
You must be signed in to change notification settings - Fork 26
task: add broadcast class implementation #2901
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
Draft
jharlow-intel
wants to merge
1
commit into
master
Choose a base branch
from
task/SAT-7028
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+368
−2
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| # ***************************************************************************** | ||
| # Copyright (c) 2026, Intel Corporation | ||
| # All rights reserved. | ||
| # | ||
| # Redistribution and use in source and binary forms, with or without | ||
| # modification, are permitted provided that the following conditions are met: | ||
| # - Redistributions of source code must retain the above copyright notice, | ||
| # this list of conditions and the following disclaimer. | ||
| # - Redistributions in binary form must reproduce the above copyright notice, | ||
| # this list of conditions and the following disclaimer in the documentation | ||
| # and/or other materials provided with the distribution. | ||
| # - Neither the name of the copyright holder nor the names of its contributors | ||
| # may be used to endorse or promote products derived from this software | ||
| # without specific prior written permission. | ||
| # | ||
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | ||
| # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF | ||
| # THE POSSIBILITY OF SUCH DAMAGE. | ||
| # ***************************************************************************** | ||
|
|
||
| """Implementation of broadcast class.""" | ||
|
|
||
| import dpnp | ||
| from dpnp.tensor._manipulation_functions import _broadcast_shapes | ||
|
|
||
|
|
||
| class broadcast: | ||
| """ | ||
| Produce an object that mimics broadcasting. | ||
|
|
||
| For full documentation refer to :obj:`numpy.broadcast`. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| *args : array_like | ||
| Input parameters. | ||
|
|
||
| Returns | ||
| ------- | ||
| broadcast : broadcast object | ||
| Broadcast the input parameters against one another, and | ||
| return an object that encapsulates the result. | ||
| Amongst others, it has ``shape`` and ``nd`` properties, and | ||
| may be used as an iterator. | ||
|
|
||
| See Also | ||
| -------- | ||
| :obj:`dpnp.broadcast_arrays` : Broadcast any number of arrays against | ||
| each other. | ||
| :obj:`dpnp.broadcast_to` : Broadcast an array to a new shape. | ||
| :obj:`dpnp.broadcast_shapes` : Broadcast the input shapes into a single | ||
| shape. | ||
|
|
||
| Examples | ||
| -------- | ||
| >>> import dpnp as np | ||
| >>> x = np.array([[1], [2], [3]]) | ||
| >>> y = np.array([4, 5, 6]) | ||
| >>> b = np.broadcast(x, y) | ||
| >>> b.shape | ||
| (3, 3) | ||
| >>> b.nd | ||
| 2 | ||
| >>> b.size | ||
| 9 | ||
|
|
||
| Notes | ||
| ----- | ||
| Iterator functionality is not supported. | ||
|
|
||
| """ | ||
|
|
||
| def __init__(self, *args): | ||
| # Convert all arguments to dpnp arrays | ||
| arrays = [] | ||
| for arg in args: | ||
| if not isinstance(arg, dpnp.ndarray): | ||
| # Convert array-like to dpnp.ndarray | ||
| arg = dpnp.asarray(arg) | ||
| arrays.append(arg) | ||
|
|
||
| if len(arrays) == 0: | ||
| raise TypeError("broadcast() requires at least one array") | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What is the reason to raise the error here? I see that numpy accept that. |
||
|
|
||
| self._arrays = tuple(arrays) | ||
|
|
||
| # Compute the broadcasted shape using _broadcast_shapes | ||
| self._shape = _broadcast_shapes(*self._arrays) | ||
|
|
||
| # Calculate size and ndim | ||
| self._size = 1 | ||
| for dim in self._shape: | ||
| self._size *= dim | ||
| self._nd = len(self._shape) | ||
|
|
||
| @property | ||
| def shape(self): | ||
| """ | ||
| Shape of the broadcasted result. | ||
|
|
||
| Returns | ||
| ------- | ||
| out : tuple | ||
| A tuple containing the shape of the broadcasted result. | ||
|
|
||
| """ | ||
| return self._shape | ||
|
|
||
| @property | ||
| def size(self): | ||
| """ | ||
| Total size of the broadcasted result. | ||
|
|
||
| Returns | ||
| ------- | ||
| out : int | ||
| The total size (number of elements) of the broadcasted result. | ||
|
|
||
| """ | ||
| return self._size | ||
|
|
||
| @property | ||
| def nd(self): | ||
| """ | ||
| Number of dimensions of the broadcasted result. | ||
|
|
||
| Returns | ||
| ------- | ||
| out : int | ||
| The number of dimensions of the broadcasted result. | ||
|
|
||
| """ | ||
| return self._nd | ||
|
|
||
| @property | ||
| def ndim(self): | ||
| """ | ||
| Number of dimensions of the broadcasted result. | ||
|
|
||
| Returns | ||
| ------- | ||
| out : int | ||
| The number of dimensions of the broadcasted result. | ||
|
|
||
| """ | ||
| return self._nd | ||
|
|
||
| @property | ||
| def numiter(self): | ||
| """ | ||
| Number of iterators possessed by the broadcast object. | ||
|
|
||
| Returns | ||
| ------- | ||
| out : int | ||
| The number of iterators. | ||
|
|
||
| """ | ||
| return len(self._arrays) | ||
|
|
||
| def __repr__(self): | ||
| return f"<broadcast shape={self.shape}, nd={self.nd}, size={self.size}>" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Conversion might be a costly operation, why do we need that?
Also, we have to allocate new arrays only on the same SYCL queue and with coerced USM type to comply with Compute follows data.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We will probably need a conversion logic only when iterator is implemented
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Btw, we need to check that input dpnp arrays are on the same queue, something like:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And also we need to check that every arg in args has
.shapeattribute