Skip to content

Commit

Permalink
clarify docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaLampert committed Oct 22, 2024
1 parent a3cd3fd commit b3d906b
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/interpolation.jl
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,7 @@ Return the system matrix, i.e., the matrix ``A`` in the linear system
Ac = f,
```
where ``c`` are the coefficients of the kernel interpolant and ``f`` the vector
of known values. The exact form of ``A`` differs depending on whether classical interpolation
or collocation is used.
of known values. The exact form of ``A`` differs depending on which method is used.
"""
system_matrix(itp::Interpolation) = itp.system_matrix

Expand All @@ -137,7 +136,9 @@ maximum degree of `m - 1`. If `m = 0`, no polynomial is added. The additional co
\sum_{j = 1}^N c_jp_k(x_j) = 0, \quad k = 1,\ldots, Q = \begin{pmatrix}m - 1 + d\\d\end{pmatrix}
```
are enforced. Returns an [`Interpolation`](@ref) object.
If `centers` is provided, the interpolant is a least squares approximation with the centers used for the basis.
A regularization can be applied to the kernel matrix using the `reg` argument, cf. [`regularize!`](@ref).
"""
function interpolate(nodeset::NodeSet{Dim, RealT}, centers::NodeSet{Dim, RealT},
Expand Down

0 comments on commit b3d906b

Please sign in to comment.