1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

//#![warn(missing_docs)]
//#![warn(missing_doc_code_examples)]
#![cfg_attr(feature = "doc-images",
cfg_attr(all(),
doc = ::embed_doc_image::embed_image!("eq-curve", "doc-images/equations/curve.svg"),
doc = ::embed_doc_image::embed_image!("eq-knots", "doc-images/equations/knots.svg"),
doc = ::embed_doc_image::embed_image!("eq-control-points", "doc-images/equations/control-points.svg"),
doc = ::embed_doc_image::embed_image!("img-curve", "doc-images/plots/manipulation/insert-before.svg")))]
//! **bsplines** is a library for vectorized, N-dimensional B-spline curves and their derivatives based on
//! [nalgebra].
//!
//! ## Features
//! - Create `N`-dimensional (`N = 1, 2, 3,...`) curves of arbitrary polynomial degree `p`.
//! - Efficient [curve evaluation][curve::Curve] for all available derivatives `k = 0, 1,... , p`.
//! - Built with [nalgebra](https://crates.io/crates/nalgebra) to store point data in contiguous arrays
//! - Multiple methods for
//!   - [curve generation][curve::generation]
//!   - [curve parametrization][curve::parameters]
//!   - [knot generation][curve::knots]
//!   - [curve manipulation][manipulation]
//!     - [knot insertion][manipulation::insert]
//!     - [reversing][manipulation::reverse]
//!     - [splitting][manipulation::split]
//!     - [merging][manipulation::split]
//!
//! ## What are B-Splines?
//!
//! 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.
//!
//! ![A 2D B-Spline curve.][img-curve]
//!
//! Still, evaluations or spatial manipulations can be executed fast because only local polynomial segments must be
//! considered and the associated numerical procedures are stable.
//! Lastly, polynomials represent a memory-efficient way of storing spatial information
//! as few polynomial coefficients suffice to describe complex shapes.

//! ## Literature:
//! |            |                                                                                                                                                                    |
//! |-----------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
//! | Piegl1997  | Piegl, L., Tiller, W. The NURBS Book. Monographs in Visual Communication. Springer, Berlin, Heidelberg, 2nd ed., 1997.                                             |
//! | Eilers1996 | Eilers, P. H. C., Marx, B. D., Flexible smoothing with B -splines and penalties, Stat. Sci., 11(2) (1996) 89–121.                                                  |
//! | Tai2003    | Tai, C.-L., Hu, S.-M., Huang, Q.-X., Approximate merging of B-spline curves via knot adjustment and constrained optimization, Comput. Des., 35(10) (2003) 893–899. |

pub mod curve;
pub mod manipulation;
pub mod types;