Improve docs #103
Improve docs #103
Conversation
|
ref #46 |
| function prefiltering_system{T,TC,GT<:GridType}(::Type{T}, ::Type{TC}, n::Int, | ||
| ::Type{Cubic{Line}}, ::Type{GT}) | ||
| prefiltering_system(T, TC, n, Quadratic{Line}, OnGrid) | ||
| function prefiltering_system{T,TC}(::Type{T}, ::Type{TC}, n::Int, |
There was a problem hiding this comment.
Did we decide not to rely on the Quadratic{Line}, OnGrid implementation here? and for Free below?
There was a problem hiding this comment.
Yes, I realized when documenting this that the systems aren't the same after all. prefiltering_system relies on inner_system_diags, which will yield different coefficients for quadratic and cubic (of course), and we lose that information if we just forward the call.
There was a problem hiding this comment.
Oh man ok. Good catch. Sounds good, it's nice to have it below he description also
|
Excellent pull request! I love the docstrings. I think this will lower the bar to mostly metaprogramming stuff for people who want to understand how Interpolations.jl works by reading the source. |
| Constant b-splines are *nearest-neighbor* interpolations, and effectively | ||
| return `A[round(Int,x)]` when interpolating | ||
|
|
||
| Also, although the implementation is slightly different in order to re-use |
There was a problem hiding this comment.
This is a copy-paste mistake; this remark is about linear, not constant, B-splines.
| @@ -78,3 +78,35 @@ function prefilter!{TWeights,TCoefs<:AbstractArray,IT<:Tuple{Vararg{Union{BSplin | |||
| end | |||
|
|
|||
| prefiltering_system(::Any, ::Any, ::Any, ::Any, ::Any) = nothing, nothing | |||
There was a problem hiding this comment.
@timholy is this method actually good for anything? It seems to me that it would be better to get MethodErrors on prefiltering_system than on whatever happens to use it...
tomasaschan
force-pushed
the
improve-docs
branch
from
e7d72f5
to
0afbede
Compare
This builds on #99, so once that's merged, this should only list the last two commits.
Replicated much of @spencerlyon2's wonderful docstrings from
Cubicfor lower-order b-splines as well as fixed some things in the originals (mostly to make it easier to tell them all apart when listing e.g.help?> Interpolations.prefiltering_system).I also found basically that all the information that was in the LaTeX document I wrote long ago is now in docstrings instead, so I removed it. (It's still in the history, if one wants to get it back.)
I haven't touched documentation for any non-B-spline interpolation code.