Skip to content

Update docstring of xp keyword in dpnp.interp #2506

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 4 commits into from
Jun 27, 2025
Merged

Update docstring of xp keyword in dpnp.interp #2506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
814d27b
Update docstring of xp keyword in dpnp.interp
antonwolfy Jun 27, 2025
51b3559
Add to the changelog
antonwolfy Jun 27, 2025
32d7ba2
Reformatting the math formula
antonwolfy Jun 27, 2025
25dbb19
Merge branch 'master' into update-interp-docstring
antonwolfy Jun 27, 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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* Improved validation of `--target-hip` build option to only accept a gfx-prefixed value [#2481](https://github.com/IntelPython/dpnp/pull/2481)
* Simplifies backend implementation of `dpnp.kaiser` by getting rid of unnecessary template [#2472](https://github.com/IntelPython/dpnp/pull/2472)
* `--onemkl-interfaces` and `--onemkl-interfaces-dir` options for building script are deprecated, instead `--onemath` and `--onemath-dir` are introduced to be aligned with [oneMath specification](https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onemath/source/) [#2487](https://github.com/IntelPython/dpnp/pull/2487)
* Clarified description of `xp` keyword in docstring of `dpnp.interp` [#2506](https://github.com/IntelPython/dpnp/pull/2506)

### Deprecated

Expand Down
12 changes: 6 additions & 6 deletions dpnp/dpnp_iface_mathematical.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2784,7 +2784,7 @@ def gradient(f, *varargs, axis=None, edge_order=1):


def interp(x, xp, fp, left=None, right=None, period=None):
"""
r"""
One-dimensional linear interpolation.

Returns the one-dimensional piecewise linear interpolant to a function
Expand All @@ -2800,11 +2800,11 @@ def interp(x, xp, fp, left=None, right=None, period=None):
to evaluate the interpolated values.

xp : {dpnp.ndarray, usm_ndarray}
Input 1-D array, expected to have a real-valued
floating-point data type. The x-coordinates of the data points,
must be increasing if argument `period` is not specified.
Otherwise, `xp` is internally sorted after normalizing
the periodic boundaries with ``xp = xp % period``.
Input 1-D array, expected to have a real-valued floating-point data
type. The x-coordinates of the data points, must be strictly increasing
if argument `period` is not specified. Otherwise, `xp` is internally
sorted after normalizing the periodic boundaries with
:math:`xp = xp \% period`.

fp : {dpnp.ndarray, usm_ndarray}
Input 1-D array. The y-coordinates of the data points,
Expand Down
Loading