diff --git a/Cargo.toml b/Cargo.toml index b173722..4c09113 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "bsplines" license = "Apache-2.0" -version = "0.0.1-alpha.6" +version = "0.0.1-alpha.7" authors = [ "Michael A. Heuer ", ] diff --git a/src/curve/basis/mod.rs b/src/curve/basis/mod.rs index 1b8be03..81bfb78 100644 --- a/src/curve/basis/mod.rs +++ b/src/curve/basis/mod.rs @@ -3,7 +3,7 @@ cfg_attr(all(), doc = ::embed_doc_image::embed_image!("eq-basis-function", "doc-images/equations/basis-function.svg"), doc = ::embed_doc_image::embed_image!("eq-basis-prefactor", "doc-images/equations/basis-prefactor.svg"), doc = ::embed_doc_image::embed_image!("eq-basis-function-zero", "doc-images/equations/basis-function-zero.svg")))] -//! Evaluates the basis spline functions using the Cox-de Boor-Mansfield recurrence relation +//! Implements the basis spline functions using the Cox-de Boor-Mansfield recurrence relation //! //! ![The Cox-de Boor-Mansfield recurrence relation][eq-basis-function] //! diff --git a/src/lib.rs b/src/lib.rs index eca474d..421b3de 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -25,12 +25,13 @@ doc = ::embed_doc_image::embed_image!("img-curve", "doc-images/plots/manipulatio //! //! ## What are B-Splines? //! -//! B-splines are parametric functions composed of piecewise polynomials with a polynomial degree `p > 0`. -//! These piecewise polynomials are joined so that the parametric function is `p-1` times continuously -//! differentiable. The overall functions are parametrized over finite domains with the co-domain being an -//! `N`-dimensional vector space. They can describe curves, but also surfaces. -//! Their characteristics lead to many desirable properties. -//! +//! B-splines are parametric functions composed of piecewise, polynomial [basis functions][curve::basis] of degree `p > 0`. +//! These piecewise polynomials are joined so that the parametric function is `p-1` times continuously differentiable. +//! The overall functions are parametrized over finite domains with a so-called [knot vector][curve::knots] +//! with the co-domain being an `N`-dimensional vector space, that is defined by [control points][curve::points]. +//! They can describe [curves][curve], but also surfaces. + +//! These characteristics lead to many desirable properties. //! The piecewise definition makes B-spline functions versatile allowing to interpolate or approximate //! complex-shaped and high-dimensional data, while maintaining a low polynomial degree. Because of the polynomial //! nature, all possible derivatives are accessible.