Skip to content

Commit aa57b0c

Browse files
committed
readme updates
1 parent 2d31143 commit aa57b0c

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,15 @@ type(bspline_3d) :: s
7070
s = bspline_3d(x,y,z,fcn,kx,ky,kz,iflag,extrap)
7171
```
7272

73+
## Spline order
74+
75+
The various `k` inputs (i.e., `kx`, `ky`, etc.) specify the spline order for each dimension. The order is the polynomial degree + 1. For example:
76+
77+
* `k=2` : Linear
78+
* `k=3` : Quadratic
79+
* `k=4` : Cubic
80+
* etc.
81+
7382
## Extrapolation
7483

7584
The library optionally supports extrapolation for points outside the range of the coefficients. This is disabled by default (in which case an error code is returned for points outside the bounds). To enable extrapolation, use the optional `extrap` input to the various `db*val` subroutines or the `initialize` methods from the object-oriented interface.
@@ -180,3 +189,10 @@ The latest API documentation can be found [here](https://jacobwilliams.github.io
180189
## License
181190

182191
The bspline-fortran source code and related files and documentation are distributed under a permissive free software [license](https://github.com/jacobwilliams/bspline-fortran/blob/master/LICENSE) (BSD-style).
192+
193+
## See also
194+
195+
* [SPLPAK](https://github.com/jacobwilliams/splpak) Multidimensional least-squares cubic spline fitting
196+
* [FINTERP](https://github.com/jacobwilliams/finterp) Multidimensional Linear Interpolation with Modern Fortran
197+
* [PCHIP](https://github.com/jacobwilliams/PCHIP) Piecewise Cubic Hermite Interpolation.
198+
* [Regridpack](https://github.com/jacobwilliams/regridpack) Linear or cubic interpolation for 1D-4D grids.

0 commit comments

Comments
 (0)