Skip to content

Commit d32a570

Browse files
docs: update docs
1 parent 3a468a0 commit d32a570

4 files changed

Lines changed: 9 additions & 11 deletions

File tree

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,11 @@ corresponding to `(u,t)` pairs.
5555
- `QuadraticSpline(u,t)` - A quadratic spline interpolation.
5656
- `CubicSpline(u,t)` - A cubic spline interpolation.
5757
- `AkimaInterpolation(u, t)` - Akima spline interpolation provides a smoothing effect and is computationally efficient.
58-
- `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:
58+
- `BSplineInterpolation(u,t,d,knotVec)` - An interpolation B-spline. This is a B-spline which hits each of the data points. The argument choices are:
5959

6060
+ `d` - degree of B-spline
61-
+ `pVec` - Symbol to Parameters Vector, `pVec = :Uniform` for uniform spaced parameters and `pVec = :ArcLen` for parameters generated by chord length method.
6261
+ `knotVec` - Symbol to Knot Vector, `knotVec = :Uniform` for uniform knot vector, `knotVec = :Average` for average spaced knot vector.
63-
- `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.
62+
- `BSplineApprox(u,t,d,h,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.
6463
- `CubicHermiteSpline(du, u, t)` - A third order Hermite interpolation, which matches the values and first (`du`) order derivatives in the data points exactly.
6564
- `PCHIPInterpolation(u, t)` - a type of `CubicHermiteSpline` where the derivative values `du` are derived from the input data in such a way that the interpolation never overshoots the data.
6665
- `QuinticHermiteSpline(ddu, du, u, t)` - A fifth order Hermite interpolation, which matches the values and first (`du`) and second (`ddu`) order derivatives in the data points exactly.

docs/src/clarification.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ using DataInterpolations, Plots
99
using DataInterpolations: derivative
1010
u = [2.0, 1.0, 5.0, 4.0, 5.0, 4.0]
1111
t = [0.0, 2.0, 3.5, 4.0, 5.0, 6.5]
12-
bspline = BSplineInterpolation(u, t, 0, :Uniform, :Uniform; extrapolation_left=ExtrapolationType.Extension, extrapolation_right=ExtrapolationType.Extension)
12+
bspline = BSplineInterpolation(u, t, 0, :Uniform; extrapolation_left=ExtrapolationType.Extension, extrapolation_right=ExtrapolationType.Extension)
1313
plot(bspline)
1414
```
1515

@@ -19,7 +19,7 @@ Thus, the plot for B-Spline interpolation does not appear the same as the plot f
1919
# Derivative behavior of quadratic B-Spline
2020

2121
```@example interpclarity
22-
bspline = BSplineInterpolation(u, t, 2, :Uniform, :Uniform; extrapolation_left=ExtrapolationType.Extension, extrapolation_right=ExtrapolationType.Extension)
22+
bspline = BSplineInterpolation(u, t, 2, :Uniform; extrapolation_left=ExtrapolationType.Extension, extrapolation_right=ExtrapolationType.Extension)
2323
plot(t->derivative(bspline, t))
2424
```
2525

docs/src/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,11 @@ corresponding to `(u,t)` pairs.
2525
- `QuadraticSpline(u,t)` - A quadratic spline interpolation.
2626
- `CubicSpline(u,t)` - A cubic spline interpolation.
2727
- `AkimaInterpolation(u, t)` - Akima spline interpolation provides a smoothing effect and is computationally efficient.
28-
- `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:
28+
- `BSplineInterpolation(u,t,d,knotVec)` - An interpolation B-spline. This is a B-spline that hits each of the data points. The argument choices are:
2929

3030
+ `d` - degree of B-spline
31-
+ `pVec` - Symbol to Parameters Vector, `pVec = :Uniform` for uniformly spaced parameters, and `pVec = :ArcLen` for parameters generated by the chord length method.
3231
+ `knotVec` - Symbol to Knot Vector, `knotVec = :Uniform` for uniform knot vector, `knotVec = :Average` for average spaced knot vector.
33-
- `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.
32+
- `BSplineApprox(u,t,d,h,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.
3433
- `CubicHermiteSpline(du, u, t)` - A third order Hermite interpolation, which matches the values and first (`du`) order derivatives in the data points exactly.
3534
- `PCHIPInterpolation(u, t)` - a type of `CubicHermiteSpline` where the derivative values `du` are derived from the input data in such a way that the interpolation never overshoots the data.
3635
- `QuinticHermiteSpline(ddu, du, u, t)` - a fifth order Hermite interpolation, which matches the values and first (`du`) and second (`ddu`) order derivatives in the data points exactly.

docs/src/methods.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,10 @@ that every data point is taken into account for each point of the curve.
124124
The interpolating B-spline is the version which hits each of the points. This
125125
method is described in more detail [here](https://pages.mtu.edu/%7Eshene/COURSES/cs3621/NOTES/INT-APP/CURVE-INT-global.html).
126126
Let's plot a cubic B-spline (3rd order). Since the data points are not close to
127-
uniformly spaced, we will use the `:ArcLen` and `:Average` choices:
127+
uniformly spaced, we will use the `:Average` knot vector:
128128

129129
```@example tutorial
130-
A = BSplineInterpolation(u, t, 3, :ArcLen, :Average)
130+
A = BSplineInterpolation(u, t, 3, :Average)
131131
plot(A)
132132
```
133133

@@ -138,7 +138,7 @@ is a least square approximation. This has a natural effect of smoothing the
138138
data. For example, if we use 4 control points, we get the result:
139139

140140
```@example tutorial
141-
A = BSplineApprox(u, t, 3, 4, :ArcLen, :Average)
141+
A = BSplineApprox(u, t, 3, 4, :Average)
142142
plot(A)
143143
```
144144

0 commit comments

Comments
 (0)