|
38 | 38 |
|
39 | 39 |
|
40 | 40 | __all__ = [ |
41 | | - "dpnp_divide" |
| 41 | + "dpnp_add", |
| 42 | + "dpnp_divide", |
| 43 | + "dpnp_multiply", |
| 44 | + "dpnp_subtract" |
42 | 45 | ] |
43 | 46 |
|
44 | 47 |
|
| 48 | +_add_docstring_ = """ |
| 49 | +add(x1, x2, out=None, order='K') |
| 50 | +
|
| 51 | +Calculates the sum for each element `x1_i` of the input array `x1` with |
| 52 | +the respective element `x2_i` of the input array `x2`. |
| 53 | +
|
| 54 | +Args: |
| 55 | + x1 (dpnp.ndarray): |
| 56 | + First input array, expected to have numeric data type. |
| 57 | + x2 (dpnp.ndarray): |
| 58 | + Second input array, also expected to have numeric data type. |
| 59 | + out ({None, dpnp.ndarray}, optional): |
| 60 | + Output array to populate. |
| 61 | + Array have the correct shape and the expected data type. |
| 62 | + order ("C","F","A","K", None, optional): |
| 63 | + Memory layout of the newly output array, if parameter `out` is `None`. |
| 64 | + Default: "K". |
| 65 | +Returns: |
| 66 | + dpnp.ndarray: |
| 67 | + an array containing the result of element-wise division. The data type |
| 68 | + of the returned array is determined by the Type Promotion Rules. |
| 69 | +""" |
| 70 | + |
| 71 | +def dpnp_add(x1, x2, out=None, order='K'): |
| 72 | + """ |
| 73 | + Invokes add() from dpctl.tensor implementation for add() function. |
| 74 | + TODO: add a pybind11 extension of add() from OneMKL VM where possible |
| 75 | + and would be performance effective. |
| 76 | +
|
| 77 | + """ |
| 78 | + |
| 79 | + # dpctl.tensor only works with usm_ndarray or scalar |
| 80 | + x1_usm_or_scalar = dpnp.get_usm_ndarray_or_scalar(x1) |
| 81 | + x2_usm_or_scalar = dpnp.get_usm_ndarray_or_scalar(x2) |
| 82 | + out_usm = None if out is None else dpnp.get_usm_ndarray(out) |
| 83 | + |
| 84 | + func = BinaryElementwiseFunc("add", ti._add_result_type, ti._add, _add_docstring_) |
| 85 | + res_usm = func(x1_usm_or_scalar, x2_usm_or_scalar, out=out_usm, order=order) |
| 86 | + return dpnp_array._create_from_usm_ndarray(res_usm) |
| 87 | + |
| 88 | + |
45 | 89 | _divide_docstring_ = """ |
46 | 90 | divide(x1, x2, out=None, order='K') |
47 | 91 |
|
@@ -88,3 +132,85 @@ def _call_divide(src1, src2, dst, sycl_queue, depends=[]): |
88 | 132 | func = BinaryElementwiseFunc("divide", ti._divide_result_type, _call_divide, _divide_docstring_) |
89 | 133 | res_usm = func(x1_usm_or_scalar, x2_usm_or_scalar, out=out_usm, order=order) |
90 | 134 | return dpnp_array._create_from_usm_ndarray(res_usm) |
| 135 | + |
| 136 | + |
| 137 | +_multiply_docstring_ = """ |
| 138 | +multiply(x1, x2, out=None, order='K') |
| 139 | +
|
| 140 | +Calculates the product for each element `x1_i` of the input array `x1` |
| 141 | +with the respective element `x2_i` of the input array `x2`. |
| 142 | +
|
| 143 | +Args: |
| 144 | + x1 (dpnp.ndarray): |
| 145 | + First input array, expected to have numeric data type. |
| 146 | + x2 (dpnp.ndarray): |
| 147 | + Second input array, also expected to have numeric data type. |
| 148 | + out ({None, dpnp.ndarray}, optional): |
| 149 | + Output array to populate. |
| 150 | + Array have the correct shape and the expected data type. |
| 151 | + order ("C","F","A","K", None, optional): |
| 152 | + Memory layout of the newly output array, if parameter `out` is `None`. |
| 153 | + Default: "K". |
| 154 | +Returns: |
| 155 | + dpnp.ndarray: |
| 156 | + an array containing the result of element-wise division. The data type |
| 157 | + of the returned array is determined by the Type Promotion Rules. |
| 158 | +""" |
| 159 | + |
| 160 | +def dpnp_multiply(x1, x2, out=None, order='K'): |
| 161 | + """ |
| 162 | + Invokes multiply() from dpctl.tensor implementation for multiply() function. |
| 163 | + TODO: add a pybind11 extension of mul() from OneMKL VM where possible |
| 164 | + and would be performance effective. |
| 165 | +
|
| 166 | + """ |
| 167 | + |
| 168 | + # dpctl.tensor only works with usm_ndarray or scalar |
| 169 | + x1_usm_or_scalar = dpnp.get_usm_ndarray_or_scalar(x1) |
| 170 | + x2_usm_or_scalar = dpnp.get_usm_ndarray_or_scalar(x2) |
| 171 | + out_usm = None if out is None else dpnp.get_usm_ndarray(out) |
| 172 | + |
| 173 | + func = BinaryElementwiseFunc("multiply", ti._multiply_result_type, ti._multiply, _multiply_docstring_) |
| 174 | + res_usm = func(x1_usm_or_scalar, x2_usm_or_scalar, out=out_usm, order=order) |
| 175 | + return dpnp_array._create_from_usm_ndarray(res_usm) |
| 176 | + |
| 177 | + |
| 178 | +_subtract_docstring_ = """ |
| 179 | +subtract(x1, x2, out=None, order='K') |
| 180 | +
|
| 181 | +Calculates the difference bewteen each element `x1_i` of the input |
| 182 | +array `x1` and the respective element `x2_i` of the input array `x2`. |
| 183 | +
|
| 184 | +Args: |
| 185 | + x1 (dpnp.ndarray): |
| 186 | + First input array, expected to have numeric data type. |
| 187 | + x2 (dpnp.ndarray): |
| 188 | + Second input array, also expected to have numeric data type. |
| 189 | + out ({None, dpnp.ndarray}, optional): |
| 190 | + Output array to populate. |
| 191 | + Array have the correct shape and the expected data type. |
| 192 | + order ("C","F","A","K", None, optional): |
| 193 | + Memory layout of the newly output array, if parameter `out` is `None`. |
| 194 | + Default: "K". |
| 195 | +Returns: |
| 196 | + dpnp.ndarray: |
| 197 | + an array containing the result of element-wise division. The data type |
| 198 | + of the returned array is determined by the Type Promotion Rules. |
| 199 | +""" |
| 200 | + |
| 201 | +def dpnp_subtract(x1, x2, out=None, order='K'): |
| 202 | + """ |
| 203 | + Invokes subtract() from dpctl.tensor implementation for subtract() function. |
| 204 | + TODO: add a pybind11 extension of sub() from OneMKL VM where possible |
| 205 | + and would be performance effective. |
| 206 | +
|
| 207 | + """ |
| 208 | + |
| 209 | + # dpctl.tensor only works with usm_ndarray or scalar |
| 210 | + x1_usm_or_scalar = dpnp.get_usm_ndarray_or_scalar(x1) |
| 211 | + x2_usm_or_scalar = dpnp.get_usm_ndarray_or_scalar(x2) |
| 212 | + out_usm = None if out is None else dpnp.get_usm_ndarray(out) |
| 213 | + |
| 214 | + func = BinaryElementwiseFunc("subtract", ti._subtract_result_type, ti._subtract, _subtract_docstring_) |
| 215 | + res_usm = func(x1_usm_or_scalar, x2_usm_or_scalar, out=out_usm, order=order) |
| 216 | + return dpnp_array._create_from_usm_ndarray(res_usm) |
0 commit comments