diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 82eb7ddd..3090d829 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-02-04T20:51:51","documenter_version":"1.2.1"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-02-06T00:30:15","documenter_version":"1.2.1"}} \ No newline at end of file diff --git a/dev/assets/Manifest.toml b/dev/assets/Manifest.toml index 327af428..0b7d401d 100644 --- a/dev/assets/Manifest.toml +++ b/dev/assets/Manifest.toml @@ -766,9 +766,9 @@ version = "0.5.5+0" [[deps.Optim]] deps = ["Compat", "FillArrays", "ForwardDiff", "LineSearches", "LinearAlgebra", "MathOptInterface", "NLSolversBase", "NaNMath", "Parameters", "PositiveFactorizations", "Printf", "SparseArrays", "StatsBase"] -git-tree-sha1 = "47fea72de134f75b105a5d4a1abe5c6aec89d390" +git-tree-sha1 = "d024bfb56144d947d4fafcd9cb5cafbe3410b133" uuid = "429524aa-4258-5aef-a3af-852621145aeb" -version = "1.9.1" +version = "1.9.2" [[deps.Opus_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] @@ -828,9 +828,9 @@ version = "1.4.0" [[deps.Plots]] deps = ["Base64", "Contour", "Dates", "Downloads", "FFMPEG", "FixedPointNumbers", "GR", "JLFzf", "JSON", "LaTeXStrings", "Latexify", "LinearAlgebra", "Measures", "NaNMath", "Pkg", "PlotThemes", "PlotUtils", "PrecompileTools", "Printf", "REPL", "Random", "RecipesBase", "RecipesPipeline", "Reexport", "RelocatableFolders", "Requires", "Scratch", "Showoff", "SparseArrays", "Statistics", "StatsBase", "UUIDs", "UnicodeFun", "UnitfulLatexify", "Unzip"] -git-tree-sha1 = "38a748946dca52a622e79eea6ed35c6737499109" +git-tree-sha1 = "c4fa93d7d66acad8f6f4ff439576da9d2e890ee0" uuid = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" -version = "1.40.0" +version = "1.40.1" [deps.Plots.extensions] FileIOExt = "FileIO" diff --git a/dev/index.html b/dev/index.html index 5660fc7c..4e8797a6 100644 --- a/dev/index.html +++ b/dev/index.html @@ -3,8 +3,8 @@ Pkg.add("DataInterpolations")
In all cases, u
an AbstractVector
of values and t
is an AbstractVector
of timepoints corresponding to (u,t)
pairs.
ConstantInterpolation(u,t)
- A piecewise constant interpolation.
LinearInterpolation(u,t)
- A linear interpolation.
QuadraticInterpolation(u,t)
- A quadratic interpolation.
LagrangeInterpolation(u,t,n)
- A Lagrange interpolation of order n
.
QuadraticSpline(u,t)
- A quadratic spline interpolation.
CubicSpline(u,t)
- A cubic spline interpolation.
AkimaInterpolation(u, t)
- Akima spline interpolation provides a smoothing effect and is computationally efficient.
BSplineInterpolation(u,t,d,pVec,knotVec)
- An interpolation B-spline. This is a B-spline that hits each of the data points. The argument choices are:
d
- degree of B-splinepVec
- Symbol to Parameters Vector, pVec = :Uniform
for uniformly spaced parameters, and pVec = :ArcLen
for parameters generated by the chord length method.knotVec
- Symbol to Knot Vector, knotVec = :Uniform
for uniform knot vector, knotVec = :Average
for average spaced knot vector.BSplineApprox(u,t,d,h,pVec,knotVec)
- A regression B-spline which smooths the fitting curve. The argument choices are the same as the BSplineInterpolation
, with the additional parameter h<length(t)
which is the number of control points to use, with smaller h
indicating more smoothing.
The following methods require extra dependencies and will be loaded as package extensions.
Curvefit(u,t,m,p,alg)
- An interpolation which is done by fitting a user-given functional form m(t,p)
where p
is the vector of parameters. The user's input p
is an initial value for a least-squares fitting, alg
is the algorithm choice to use to optimize the cost function (sum of squared deviations) via Optim.jl
and optimal p
s are used in the interpolation. Requires using Optim
.RegularizationSmooth(u,t,d;λ,alg)
- A regularization algorithm (ridge regression) which is done by minimizing an objective function (l2 loss + derivatives of order d
) integrated in the time span. It is a global method which creates a smooth curve. Requires using RegularizationTools
.DataInterpolations.jl is tied into the Plots.jl ecosystem, by way of RecipesBase. Any interpolation can be plotted using the plot
command (or any other), since they have type recipes associated with them.
For convenience, and to allow keyword arguments to propagate properly, DataInterpolations.jl also defines several series types, corresponding to different interpolations.
The series types defined are:
:linear_interp
:quadratic_interp
:lagrange_interp
:quadratic_spline
:cubic_spline
By and large, these accept the same keywords as their function counterparts.
Please refer to the SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages for guidance on PRs, issues, and other matters relating to contributing to SciML.
See the SciML Style Guide for common coding practices and other style decisions.
There are a few community forums:
Status `~/work/DataInterpolations.jl/DataInterpolations.jl/docs/Project.toml`
[82cc6244] DataInterpolations v4.6.0 `~/work/DataInterpolations.jl/DataInterpolations.jl`
[e30172f5] Documenter v1.2.1
- [429524aa] Optim v1.9.1
- [91a5bcdd] Plots v1.40.0
+ [429524aa] Optim v1.9.2
+ [91a5bcdd] Plots v1.40.1
[29dad682] RegularizationTools v0.6.0
[860ef19b] StableRNGs v1.0.1
Julia Version 1.10.0
Commit 3120989f39b (2023-12-25 18:01 UTC)
@@ -82,14 +82,14 @@
[d41bc354] NLSolversBase v7.8.3
[77ba4419] NaNMath v1.0.2
[4d8831e6] OpenSSL v1.4.1
- [429524aa] Optim v1.9.1
+ [429524aa] Optim v1.9.2
[bac558e1] OrderedCollections v1.6.3
[d96e819e] Parameters v0.12.3
[69de0a69] Parsers v2.8.1
[b98c9c47] Pipe v1.3.0
[ccf2f8ad] PlotThemes v3.1.0
[995b91a9] PlotUtils v1.4.0
- [91a5bcdd] Plots v1.40.0
+ [91a5bcdd] Plots v1.40.1
[85a6dd25] PositiveFactorizations v0.2.4
[aea7be01] PrecompileTools v1.2.0
[21216c6a] Preferences v1.4.1
@@ -249,4 +249,4 @@
[8e850b90] libblastrampoline_jll v5.8.0+1
[8e850ede] nghttp2_jll v1.52.0+1
[3f19e933] p7zip_jll v17.4.0+2
-Info Packages marked with ⌅ have new versions available but compatibility constraints restrict them from upgrading. To see why use `status --outdated -m`
You can also download the manifest file and the project file.
Settings
This document was generated with Documenter.jl version 1.2.1 on Sunday 4 February 2024. Using Julia version 1.10.0.