splinekit 0.2.3__tar.gz → 0.2.4__tar.gz

{splinekit-0.2.3 → splinekit-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splinekit
-Version: 0.2.3
+Version: 0.2.4
 Summary: A set of functions and classes to handle periodic 1D polynomial splines
 Author-Email: =?utf-8?q?Philippe_Th=C3=A9venaz?= <philippe.thevenaz@icloud.com>
 Maintainer-Email: =?utf-8?q?Philippe_Th=C3=A9venaz?= <philippe.thevenaz@icloud.com>
@@ -120,5 +120,5 @@ First stable version. Pure Python.
 ### 0.2.1
 Same API as 0.1.0. Ansi-C dynamic library.
 
-### 0.2.2
+### 0.2.2 — 0.2.4
 Some demos added

{splinekit-0.2.3 → splinekit-0.2.4}/README.md

@@ -69,5 +69,5 @@ First stable version. Pure Python.
 ### 0.2.1
 Same API as 0.1.0. Ansi-C dynamic library.
 
-### 0.2.2
+### 0.2.2 — 0.2.4
 Some demos added

{splinekit-0.2.3 → splinekit-0.2.4}/docs/demos/bspline/bspline_bases.rst

@@ -89,10 +89,10 @@ While a B-spline has many favorable properties, it comes at a price: it is not i
 In the sequel, the B-spline basis provides the reference to which all other bases will be compared. We set
 
 ..  math::
-        \begin{eqnarray*}
+        \begin{array}{rcl}
         f:{\mathbb{R}}\rightarrow{\mathbb{R}},\;x\mapsto f(x)&=&\sum_{k\in{\mathbb{R}}}\,c[k]\,\varphi(x-k)\\
         &=&\sum_{k\in{\mathbb{R}}}\,c_{1}[k]\,\beta^{n}(x-k).
-        \end{eqnarray*}
+        \end{array}
 
 Here, we plot a B-spline over its support, indexed by its degree.
 
@@ -113,11 +113,11 @@ There exists a basis :math:`\eta^{n}` that happens to be interpolating. It is ca
 It then holds that
 
 ..  math::
-        \begin{eqnarray*}
+        \begin{array}{rcl}
         f:{\mathbb{R}}\rightarrow{\mathbb{R}},\;x\mapsto f(x)&=&\sum_{k\in{\mathbb{R}}}\,c[k]\,\varphi(x-k)\\
         &=&\sum_{k\in{\mathbb{R}}}\,c_{1}[k]\,\beta^{n}(x-k)\\
         &=&\sum_{k\in{\mathbb{R}}}\,c_{2}[k]\,\eta^{n}(x-k).
-        \end{eqnarray*}
+        \end{array}
 
 
 Here, we plot a cardinal B-spline, indexed by its degree.
@@ -148,12 +148,12 @@ Dual B-Spline
 Let the basis :math:`\mathring{\beta}^{n_{2},n_{1}}` of dual degree :math:`n_{2}\in{\mathbb{N}}` and primal degree :math:`n_{1}\in{\mathbb{N}}` be called a dual B-spline. It is yet another basis that is sometimes used to provide an alternate (equivalent) representation of the spline as
 
 ..  math::
-        \begin{eqnarray*}
+        \begin{array}{rcl}
         f:{\mathbb{R}}\rightarrow{\mathbb{R}},\;x\mapsto f(x)&=&\sum_{k\in{\mathbb{R}}}\,c[k]\,\varphi(x-k)\\
         &=&\sum_{k\in{\mathbb{R}}}\,c_{1}[k]\,\beta^{n}(x-k)\\
         &=&\sum_{k\in{\mathbb{R}}}\,c_{2}[k]\,\eta^{n}(x-k)\\
         &=&\sum_{k\in{\mathbb{R}}}\,c_{3}[k]\,\mathring{\beta}^{n,n_{1}}(x-k).
-        \end{eqnarray*}
+        \end{array}
 
 Here, the equality of the representations of :math:`f` is achieved only if we set :math:`n_{2}=n,` while the primal degree :math:`n_{1}\in{\mathbb{N}}` is free. The defining property of a dual B-spline is that it is the unique spline of degree :math:`n_{2}` which, once convolved with a B-spline of degree :math:`n_{1},` results in a cardinal, interpolating spline. Formally, this is written as
 
@@ -186,13 +186,13 @@ Orthonormal B-Spline
 Let the orthonormal B-spline :math:`\phi^{n}` of degree :math:`n` be a final basis of interest that is sometimes used to provide an alternate (equivalent) representation of the spline as
 
 ..  math::
-        \begin{eqnarray*}
+        \begin{array}{rcl}
         f:{\mathbb{R}}\rightarrow{\mathbb{R}},\;x\mapsto f(x)&=&\sum_{k\in{\mathbb{R}}}\,c[k]\,\varphi(x-k)\\
         &=&\sum_{k\in{\mathbb{R}}}\,c_{1}[k]\,\beta^{n}(x-k)\\
         &=&\sum_{k\in{\mathbb{R}}}\,c_{2}[k]\,\eta^{n}(x-k)\\
         &=&\sum_{k\in{\mathbb{R}}}\,c_{3}[k]\,\mathring{\beta}^{n,n_{1}}(x-k)\\
         &=&\sum_{k\in{\mathbb{R}}}\,c_{4}[k]\,\phi^{n}(x-k).
-        \end{eqnarray*}
+        \end{array}
 
 The defining property of the orthonormal B-spline is that it is the unique (up to its sign) spline of degree :math:`n` which, once convolved with itself, results in a cardinal, interpolating spline. Formally, this is written as
 

{splinekit-0.2.3 → splinekit-0.2.4}/docs/demos/bspline/bspline_inverse.rst

@@ -24,10 +24,10 @@ B-splines are continuously defined functions :math:`\beta^{n}:{\mathbb{R}}\right
 One question that arises now is whether the sequence :math:`b^{n}` possesses a discrete-convolution inverse sequence. Let us notate such inverse sequence as :math:`\left(b^{n}\right)^{-1}.` What we are primarily asking is whether there exists :math:`\left(b^{n}\right)^{-1}` such that
 
 ..  math::
-        \begin{eqnarray*}
+        \begin{array}{rcl}
         \forall k\in{\mathbb{Z}}:{\mathbf{[\![}}k=0\,{\mathbf{]\!]}}&=&\left(\left(b^{n}\right)^{-1}*b^{n}\right)[k]\\
         &=&\sum_{q\in{\mathbb{Z}}}\,\left(b^{n}\right)^{-1}[q]\,b^{n}[k-q],
-        \end{eqnarray*}
+        \end{array}
 
 where the notation :math:`{\mathbf{[\![}}\cdot\,{\mathbf{]\!]}}` is that of the Iverson bracket. (From a mathematical point of view, let us observe that the convolution is always well-defined because of the finite-support property of :math:`b^{n}.`)
 

{splinekit-0.2.3 → splinekit-0.2.4}/docs/demos/bspline/bspline_poles.rst

@@ -41,10 +41,10 @@ Every function :math:`f` built this way is said to be a spline. Remarkably, the
 One often deploys splines with the purpose of interpolating data samples. In practice, given a :math:`Q`-dimensional vector :math:`{\mathbf{y}}\in{\mathbb{R}}^{Q}` of samples, it is desired to find a specific sequence of coefficients :math:`c` that results in a spline :math:`f` satisfying the interpolation constraint :math:`\left(f(q)\right)_{q=0}^{Q-1}={\mathbf{y}}.` Unfortunately, the coefficients are not unique. Indeed, suppose that one has found a sequence :math:`c` that satisfies the interpolation constraint. Then, other sequences :math:`c'` can be established as
 
 ..  math::
-        \begin{eqnarray}
+        \begin{array}{rcl}
         \forall q\in{\mathbb{Z}}:f(q)&=&\sum_{k\in{\mathbb{Z}}}\,c[k]\,\beta^{n}(q-k)\\
         &=&\sum_{k\in{\mathbb{Z}}}\,\underbrace{\left(c[k]+\sum_{m=1}^{\left\lfloor n/2\right\rfloor}\,\left(\lambda_{m}^{-}\,z_{n,m}^{-k}+\lambda_{m}^{+}\,z_{n,m}^{k}\right)\right)}_{c'[k]}\,\beta^{n}(q-k),
-        \end{eqnarray}
+        \end{array}
 
 where :math:`\lambda_{m}^{-}` and :math:`\lambda_{m}^{+}` are unconstrained real numbers which, altogether, provide :math:`2\,\left\lfloor n/2\right\rfloor` degrees of liberty.
 

{splinekit-0.2.3 → splinekit-0.2.4}/docs/demos/bspline/spline_vs_poly.rst

@@ -56,10 +56,10 @@ Partition of Monomials
 The generic polynomial :math:`\pi_{n}:{\mathbb{R}}\rightarrow{\mathbb{R}},x\mapsto\pi_{n}(x)=a_{0}+\sum_{m=1}^{n}\,a_{m}\,x^{m}` is a weighted linear sum of a constant term :math:`1` and of canonic monomials :math:`x^{m},` with respective weights :math:`a_{0}` and :math:`a_{m}.` If we want to discover the spline coefficients :math:`c` needed to represent :math:`\pi_{n}` as a spline, all we need to know is which are the spline coefficients :math:`c_{m}^{n}` that will represent the monomial of degree :math:`m` as the spline :math:`\sum_{k\in{\mathbb{Z}}}\,c_{m}^{n}[k]\,\beta^{n}(x-k)` for :math:`x\in{\mathbb{R}},` assuming that :math:`0<m\leq n.` Then, the finite-support property of B-splines will alleviate concerns about the convergence of the sums involved and will allow us to write that
 
 ..  math::
-        \begin{eqnarray}
+        \begin{array}{rcl}
         \pi_{n}(x)&=&a_{0}\,\left(\sum_{k\in{\mathbb{Z}}}\,\beta^{n}(x-k)\right)+\sum_{m=1}^{n}\,a_{m}\,\left(\sum_{k\in{\mathbb{Z}}}\,c_{m}^{n}[k]\,\beta^{n}(x-k)\right)\\
         &=&\sum_{k\in{\mathbb{Z}}}\,\left(a_{0}+\sum_{m=1}^{n}\,a_{m}\,c_{m}^{n}[k]\right)\,\beta^{n}(x-k).
-        \end{eqnarray}
+        \end{array}
 
 The identification :math:`c[k]=a_{0}+\sum_{m=1}^{n}\,a_{m}\,c_{m}^{n}[k]` for :math:`k\in{\mathbb{Z}}` will finally result in the desired representation :math:`\pi_{n}(x)=\sum_{k\in{\mathbb{Z}}}\,c[k]\,\beta^{n}(x-k)` for :math:`x\in{\mathbb{R}}.`
 

{splinekit-0.2.3 → splinekit-0.2.4}/docs/demos/spline1d/bounds.rst

@@ -65,10 +65,10 @@ Assume finally that :math:`n>m>0.` In this case, letting :math:`{\mathbf{e}}_{m+
 satisfies our requirements. Indeed, for all :math:`x\in{\mathbb{X}}_{r},` some algebraic manipulations lead to
 
 ..  math::
-        \begin{eqnarray*}
+        \begin{array}{rcl}
         0&\leq&{\mathbf{u}}_{r}^{{\mathsf{T}}}\,{\mathbf{W}}^{m}\,{\mathbf{v}}^{m}({\mathrm{frac}}(x-\frac{m-1}{2}-\delta y))-{\mathbf{c}}_{r}^{{\mathsf{T}}}\,{\mathbf{W}}^{n}\,{\mathbf{v}}^{n}(\chi)\\
         &=&\chi^{m}\,\sum_{k=m+1}^{n}\,\left\{\begin{array}{ll}-a_{k+1}\,\chi^{k-m},&a_{k+1}<0\\a_{k+1}\,\left(1-\chi^{k-m}\right),&0\leq a_{k+1}.\end{array}\right.
-        \end{eqnarray*}
+        \end{array}
 
 Global Bound
 ^^^^^^^^^^^^
@@ -91,10 +91,10 @@ and observe that
 The nonnegativity of B-splines allows us to finally establish that
 
 ..  math::
-        \begin{eqnarray*}
+        \begin{array}{rcl}
         \forall x\in{\mathbb{X}}_{r}:g(x)-{\mathbf{u}}_{r}^{{\mathsf{T}}}\,{\mathbf{W}}^{m}\,{\mathbf{v}}^{m}(\chi)&=&\sum_{k=0}^{m}\,\left(\left(\max_{\rho=0}^{m}\,\left[{\mathbf{u}}_{{\left(\rho-k+r\right)\bmod K}}\right]_{\rho+1}\right)-\left[{\mathbf{u}}_{r}\right]_{k+1}\right)\,\beta^{m}(x-\delta y+r-k)\\
         &\geq&\sum_{k=0}^{m}\,\left(\left[{\mathbf{u}}_{r}\right]_{k+1}-\left[{\mathbf{u}}_{r}\right]_{k+1}\right)\,\beta^{m}(x-\delta y+r-k)=0,
-        \end{eqnarray*}
+        \end{array}
 
 from which we conclude that :math:`g` is an upper bound of :math:`f.`
 

{splinekit-0.2.3 → splinekit-0.2.4}/docs/demos/spline1d/evaluation.rst

@@ -28,10 +28,10 @@ where :math:`K\in{\mathbb{N}}+1` is a positive integer period, :math:`c` is an a
 Since the support of a B-spline is finite, the sum is finite at any given argument :math:`x.` Moreover, since B-splines of positive degrees are themselves made of unit-length pieces of polynomials, one can deploy the formalism of linear-algebra to make the expression of the spline recipe take the form
 
 ..  math::
-        \begin{eqnarray*}
+        \begin{array}{rcl}
         \forall n\in{\mathbb{N}}+1,\forall x\in{\mathbb{R}}:f(x)&=&\left(\begin{array}{c}c[{\left(-r\right)\bmod K}]\\c[{\left(1-r\right)\bmod K}]\\c[{\left(2-r]\right)\bmod K}\\\vdots\\c[{\left(n-r\right)\bmod K}]\end{array}\right)^{{\mathsf{T}}}\,\left(\begin{array}{ccccc}w_{0,0}^{n}&w_{0,1}^{n}&w_{0,2}^{n}&\cdots&w_{0,n}^{n}\\w_{1,0}^{n}&w_{1,1}^{n}&w_{1,2}^{n}&\cdots&w_{1,n}^{n}\\w_{2,0}^{n}&w_{2,1}^{n}&w_{2,2}^{n}&\cdots&w_{2,n}^{n}\\\vdots&\vdots&\vdots&\ddots&\vdots\\w_{n,0}^{n}&w_{n,1}^{n}&w_{n,2}^{n}&\cdots&w_{n,n}^{n}\end{array}\right)\,\left(\begin{array}{c}1\\v\\v^{2}\\\vdots\\v^{n}\end{array}\right)\\
         &=&{\color{blue}{{\mathbf{c}}}}^{{\mathsf{T}}}\,{\color{blue}{{\mathbf{W}}^{n}}}\,{\color{blue}{{\mathbf{v}}^{n}}},
-        \end{eqnarray*}
+        \end{array}
 
 where :math:`{\color{blue}{{\mathbf{c}}}}\in{\mathbb{R}}^{n+1}` is a vector whose :math:`n+1` components are extracted from the data-dependent array :math:`c` at some integer :math:`r\in{\mathbb{Z}}` that depends in discrete fashion on :math:`\left(x-\delta x\right),` where :math:`{\color{blue}{{\mathbf{W}}^{n}}}\in{\mathbb{R}}^{\left(n+1\right)\times\left(n+1\right)}` is a matrix that depends on :math:`n` only, and where :math:`{\color{blue}{{\mathbf{v}}^{n}}}\in{\mathbb{R}}^{n+1}` is a Vandermonde vector whose every component belongs to the interval :math:`[0,1]` and is made to depend continuously on :math:`\left(x-\delta x\right).`
 

{splinekit-0.2.3 → splinekit-0.2.4}/docs/demos/spline1d/polynomials.rst

@@ -48,10 +48,10 @@ This function is made of polynomial pieces because of the term :math:`x^{n}` in
 In accord with the definition, the B-spline of degree zero is
 
 ..  math::
-        \begin{eqnarray*}
+        \begin{array}{rcl}
         \beta^{0}(x)&=&\varsigma^{0}(x+\frac{1}{2})-\varsigma^{0}(x-\frac{1}{2})\\
         &=&\left\{\begin{array}{ll}1,&\left|x\right|<\frac{1}{2}\\\frac{1}{2},&\left|x\right|=\frac{1}{2}\\0,&\frac{1}{2}<\left|x\right|.\end{array}\right.
-        \end{eqnarray*}
+        \end{array}
 
 Among many important properties, for all degrees :math:`n\in{\mathbb{N}}` and for all :math:`x\in{\mathbb{R}},` the B-splines thus defined
 

{splinekit-0.2.3 → splinekit-0.2.4}/pyproject.toml

@@ -12,7 +12,7 @@ build-backend = "scikit_build_core.build" # Activate for C dynamic library
 # Project
 [project]
 name = "splinekit"
-version = "0.2.3"
+version = "0.2.4"
 dependencies = [
     "numpy >=1.26",
     "scipy >=1.15",

{splinekit-0.2.3 → splinekit-0.2.4}/src/splinekit/bases.py

@@ -18,12 +18,12 @@ class Bases:
 
     ..  math::
 
-        \begin{eqnarray*}
+        \begin{array}{rcl}
         f(x)&=&\sum_{k\in{\mathbb{Z}}}\,c[k]\,\beta^{n}(x-k)\\
         &=&\sum_{k\in{\mathbb{Z}}}\,f(k)\,\eta^{n}(x-k)\\
         &=&\sum_{k\in{\mathbb{Z}}}\,g[k]\,\mathring{\beta}^{n,n}(x-k)\\
         &=&\sum_{k\in{\mathbb{Z}}}\,a[k]\,\phi^{n}(x-k).
-        \end{eqnarray*}
+        \end{array}
 
     In general, while the spline :math:`f` remains the same, the coefficients
     are mutually different, with

{splinekit-0.2.3 → splinekit-0.2.4}/src/splinekit/bsplines.py

@@ -1195,7 +1195,7 @@ def convolve_b_spline_monomial (
 
     ..  math::
 
-        \begin{eqnarray*}
+        \begin{array}{rcl}
         \left({\mathrm{D}}^{d}\beta^{n}*\left(\cdot\right)^{m}\right)(x)&=&
         \int_{{\mathbb{R}}}\,
         \frac{{\mathrm{d}}^{d}\beta^{n}(y)}{{\mathrm{d}}y^{d}}\,
@@ -1205,7 +1205,7 @@ def convolve_b_spline_monomial (
         \left(x+\frac{n+1}{2}-k\right)^{m+n+1-d}\\
         &=&\textcolor{green}{\gamma_{m}^{n}[0]+
         \sum_{k=1}^{m+n+1-d}\,\gamma_{m}^{n}[k]\,x^{k}}.
-        \end{eqnarray*}
+        \end{array}
 
     Parameters
     ----------

{splinekit-0.2.3 → splinekit-0.2.4}/src/splinekit/periodic_spline_1d.py

@@ -1223,12 +1223,12 @@ class PeriodicSpline1D:
 
         ..  math::
 
-            \begin{eqnarray*}
+            \begin{array}{rcl}
             s_{1}(x)&=&\sum_{k\in{\mathbb{Z}}}\,c_{1}[{k\bmod K}]\,
             \beta^{n_{1}}(x-\delta x_{1}-k)\\
             s_{2}(x)&=&\sum_{k\in{\mathbb{Z}}}\,c_{2}[{k\bmod K}]\,
             \beta^{n_{2}}(x-\delta x_{2}-k),
-            \end{eqnarray*}
+            \end{array}
 
         the created sum
 
@@ -1321,12 +1321,12 @@ class PeriodicSpline1D:
 
         ..  math::
 
-            \begin{eqnarray*}
+            \begin{array}{rcl}
             s_{1}(x)&=&\sum_{k\in{\mathbb{Z}}}\,c_{1}[{k\bmod K}]\,
             \beta^{n_{1}}(x-\delta x_{1}-k)\\
             s_{2}(x)&=&\sum_{k\in{\mathbb{Z}}}\,c_{2}[{k\bmod K}]\,
             \beta^{n_{2}}(x-\delta x_{2}-k),
-            \end{eqnarray*}
+            \end{array}
 
         the created convolution result is
 
@@ -1413,12 +1413,12 @@ class PeriodicSpline1D:
 
         ..  math::
 
-            \begin{eqnarray*}
+            \begin{array}{rcl}
             s_{1}(x)&=&\sum_{k\in{\mathbb{Z}}}\,c_{1}[{k\bmod K}]\,
             \beta^{n_{1}}(x-\delta x_{1}-k)\\
             s_{2}(x)&=&\sum_{k\in{\mathbb{Z}}}\,c_{2}[{k\bmod K}]\,
             \beta^{n_{2}}(x-\delta x_{2}-k),
-            \end{eqnarray*}
+            \end{array}
 
         the created zero-normalized cross-correlation result
         :math:`f(x)\in[-1,1]` is
@@ -2355,12 +2355,12 @@ class PeriodicSpline1D:
 
         ..  math::
 
-            \begin{eqnarray*}
+            \begin{array}{rcl}
             f(x)&=&\sum_{k\in{\mathbb{Z}}}\,c[{k\bmod K}]\,
             \beta^{n}(x-\delta x-k)\\
             &=&{\mathbf{c}}^{{\mathsf{T}}}\,{\mathbf{W}}^{n}\,
             {\mathbf{v}}^{n}(\chi).
-            \end{eqnarray*}
+            \end{array}
 
         There, :math:`c` are the :math:`K` spline coefficients,
         :math:`{\mathbf{c}}=\left(c[{\left(k-r\right)\bmod
@@ -2461,13 +2461,13 @@ class PeriodicSpline1D:
 
         ..  math::
 
-            \begin{eqnarray*}
+            \begin{array}{rcl}
             \left(f(x_{0}+\frac{q}{M})\right)_{q=0}^{L\,M-1}&=&
             \left(\sum_{k\in{\mathbb{Z}}}\,c[{k\bmod K}]\,
             \beta^{n}(x_{0}+\frac{q}{M}-\delta x-k)\right)_{q=0}^{L\,M-1}\\
             &=&\left({\mathbf{c}}_{q}^{{\mathsf{T}}}\,{\mathbf{W}}^{n}\,
             {\mathbf{v}}^{n}(\chi_{x_{0}})\right)_{q=0}^{L\,M-1}.
-            \end{eqnarray*}
+            \end{array}
 
         There, :math:`L` is ``support_length``, :math:`M` is ``oversampling``,
         :math:`x_{0}` is ``starting_at``, and :math:`c` are the :math:`K`
@@ -4575,12 +4575,12 @@ class PeriodicSpline1D:
 
         ..  math::
 
-            \begin{eqnarray*}
+            \begin{array}{rcl}
             f(x)&=&\sum_{k\in{\mathbb{Z}}}\,c[{k\bmod K}]\,
             \beta^{n}(x-\delta x-k)\\
             &=&{\mathbf{c}}^{{\mathsf{T}}}\,{\mathbf{W}}^{n}\,
             {\mathbf{v}}^{n}(\chi).
-            \end{eqnarray*}
+            \end{array}
 
         There, :math:`c` are the :math:`K` spline coefficients,
         :math:`{\mathbf{c}}=\left(c[{\left(k-r\right)\bmod