Skip to content

Style fixes to triintepolate docs. #19422

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 1 commit into from
Feb 2, 2021
+12 −12
Merged

Style fixes to triintepolate docs. #19422

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions lib/matplotlib/tri/triinterpolate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,14 +114,14 @@ def _interpolate_multikeys(self, x, y, tri_index=None,
The purpose of :meth:`_interpolate_multikeys` is to implement the
following common tasks needed in all subclasses implementations:

- calculation of containing triangles
- dealing with more than one interpolation request at the same
location (e.g., if the 2 derivatives are requested, it is
unnecessary to compute the containing triangles twice)
- scaling according to self._unit_x, self._unit_y
- dealing with points outside of the grid (with fill value np.nan)
- dealing with multi-dimensional *x*, *y* arrays: flattening for
:meth:`_interpolate_params` call and final reshaping.
- calculation of containing triangles
- dealing with more than one interpolation request at the same
location (e.g., if the 2 derivatives are requested, it is
unnecessary to compute the containing triangles twice)
- scaling according to self._unit_x, self._unit_y
- dealing with points outside of the grid (with fill value np.nan)
- dealing with multi-dimensional *x*, *y* arrays: flattening for
:meth:`_interpolate_params` call and final reshaping.

(Note that np.vectorize could do most of those things very well for
you, but it does it by function evaluations over successive tuples of
Expand Down Expand Up @@ -214,9 +214,9 @@ def _interpolate_single_key(self, return_key, tri_index, x, y):
Parameters
----------
return_key : {'z', 'dzdx', 'dzdy'}
Identifies the requested values (z or its derivatives)
The requested values (z or its derivatives).
tri_index : 1D int array
Valid triangle index (-1 prohibited)
Valid triangle index (cannot be -1).
x, y : 1D arrays, same shape as `tri_index`
Valid locations where interpolation is requested.

Expand Down Expand Up @@ -245,8 +245,8 @@ class LinearTriInterpolator(TriInterpolator):
z : array-like of shape (npoints,)
Array of values, defined at grid points, to interpolate between.
trifinder : `~matplotlib.tri.TriFinder`, optional
If this is not specified, the Triangulation's default TriFinder will
be used by calling `.Triangulation.get_trifinder`.
If this is not specified, the Triangulation's default TriFinder will
be used by calling `.Triangulation.get_trifinder`.

Methods
-------
Expand Down