From 8692b6b5217fe42f7e6fb98f48630755541bfa38 Mon Sep 17 00:00:00 2001 From: oscarddssmith Date: Tue, 8 Apr 2025 11:29:33 -0400 Subject: [PATCH 1/2] remove kwargs from docs --- README.md | 20 +------------------- docs/src/index.md | 24 +++--------------------- 2 files changed, 4 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index a6182583..f62d9221 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ corresponding to `(u,t)` pairs. - `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 which hits each of the data points. The argument choices are: - + + `d` - degree of B-spline + `pVec` - Symbol to Parameters Vector, `pVec = :Uniform` for uniform spaced parameters and `pVec = :ArcLen` for parameters generated by chord length method. + `knotVec` - Symbol to Knot Vector, `knotVec = :Uniform` for uniform knot vector, `knotVec = :Average` for average spaced knot vector. @@ -76,24 +76,6 @@ The follow methods require extra dependencies and will be loaded as package exte 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` - - `:akima_interp` - - `:bspline_interp` - - `:bspline_approx` - - `:cubic_hermite_spline` - - `:pchip_interp` - - `:quintic_hermite_spline` - -By and large, these accept the same keywords as their function counterparts. - -Some keywords differ from regular plots. `label_interp` is used to label the interpolation line plot, while `label_data` labels the data points. By default, both are plotted in the same color. - ## Citing If you use this software in your work, please cite: diff --git a/docs/src/index.md b/docs/src/index.md index ad1c4b18..86523fce 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -25,7 +25,7 @@ corresponding to `(u,t)` pairs. - `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-spline + `pVec` - 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. @@ -44,25 +44,7 @@ The following methods require extra dependencies and will be loaded as package e ## Plotting -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` - - `:akima_interp` - - `:bspline_interp` - - `:bspline_approx` - - `:cubic_hermite_spline` - - `:pchip_interp` - - `:quintic_hermite_spline` - -By and large, these accept the same keywords as their function counterparts. - -Some keywords differ from regular plots. `label_interp` is used to label the interpolation line plot, while `label_data` labels the data points. By default, both are plotted in the same color. +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. ## Citing @@ -91,7 +73,7 @@ If you use this software in your work, please cite: - See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions. - There are a few community forums: - + + The #diffeq-bridged and #sciml-bridged channels in the [Julia Slack](https://julialang.org/slack/) + The #diffeq-bridged and #sciml-bridged channels in the From 838d529ca53ac85ab46bab44bb1fbc40a8bb1adf Mon Sep 17 00:00:00 2001 From: oscarddssmith Date: Tue, 8 Apr 2025 13:04:26 -0400 Subject: [PATCH 2/2] format --- README.md | 2 +- docs/src/index.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f62d9221..519724f5 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ corresponding to `(u,t)` pairs. - `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 which hits each of the data points. The argument choices are: - + + `d` - degree of B-spline + `pVec` - Symbol to Parameters Vector, `pVec = :Uniform` for uniform spaced parameters and `pVec = :ArcLen` for parameters generated by chord length method. + `knotVec` - Symbol to Knot Vector, `knotVec = :Uniform` for uniform knot vector, `knotVec = :Average` for average spaced knot vector. diff --git a/docs/src/index.md b/docs/src/index.md index 86523fce..2fa2da4d 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -25,7 +25,7 @@ corresponding to `(u,t)` pairs. - `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-spline + `pVec` - 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. @@ -73,7 +73,7 @@ If you use this software in your work, please cite: - See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions. - There are a few community forums: - + + The #diffeq-bridged and #sciml-bridged channels in the [Julia Slack](https://julialang.org/slack/) + The #diffeq-bridged and #sciml-bridged channels in the