lsdo-function-spaces 1.2.0__tar.gz → 1.2.1__tar.gz

{lsdo_function_spaces-1.2.0/lsdo_function_spaces.egg-info → lsdo_function_spaces-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lsdo_function_spaces
-Version: 1.2.0
+Version: 1.2.1
 Summary: A package for functional representation and function spaces in multidisciplinary design optimization.
 Author-email: Andrew Fletcher <afletcher168@gmail.com>
 License-Expression: Apache-2.0

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/__init__.py

@@ -2,7 +2,7 @@
 
 import multiprocessing
 
-__version__ = "1.2.0"
+__version__ = "1.2.1"
 num_workers = multiprocessing.cpu_count()
 
 # NumPy 2.x compatibility patch for CSDL_alpha SetVarIndex

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/core/function.py

@@ -956,7 +956,7 @@ class Function:
         Plots the B-spline Surface.
 
         Parameters
-        -----------
+        ----------
         points_type : list = ['evaluated_points']
             The type of points to be plotted. {evaluated_points, coefficients}
         plot_types : list = ['function']
@@ -1033,7 +1033,7 @@ class Function:
         Plots the points of the function.
 
         Parameters
-        -----------
+        ----------
         points_type : str = 'evaluated_points'
             The type of points to be plotted. {evaluated_points, coefficients}
         opactity : float = 1.
@@ -1063,7 +1063,7 @@ class Function:
         Plots the function as a curve. NOTE: This should only be called if the function is a curve!
 
         Parameters
-        -----------
+        ----------
         points_type : str = 'evaluated_points'
             The type of points to be plotted. {evaluated_points, coefficients}
         opactity : float = 1.
@@ -1148,7 +1148,7 @@ class Function:
         Plots the function as a surface. NOTE: This should only be called if the function is a surface!
 
         Parameters
-        -----------
+        ----------
         points_type : str = 'evaluated_points'
             The type of points to be plotted. {evaluated_points, coefficients}
         plot_types : list = ['function']
@@ -1261,7 +1261,7 @@ class Function:
         Plots the function as a volume. NOTE: This should only be called if the function is a volume!
 
         Parameters
-        -----------
+        ----------
         points_type : str = 'evaluated_points'
             The type of points to be plotted. {evaluated_points, coefficients}
         plot_types : list = ['function']

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/core/function_network.py

@@ -14,7 +14,7 @@ from lsdo_function_spaces.core.interface import Interface, InterfaceCondition, C
 
 @dataclass
 class RankNullityReport:
-    """
+    r"""
     Diagnostic report of constraint matrix rank, redundancy, and nullity.
 
     Parameters
@@ -24,15 +24,15 @@ class RankNullityReport:
     num_constraints : int
         Total number of scalar constraint equations evaluated.
     rank : int
-        Numerical rank $r = \\mathrm{rank}(J_c)$ computed via singular value decomposition.
+        Numerical rank :math:`r = \mathrm{rank}(J_c)` computed via singular value decomposition.
     redundancy : int
-        Number of redundant constraint equations: $p - r$.
+        Number of redundant constraint equations: :math:`p - r`.
     nullity : int
-        Dimension of the constraint null space: $n - r$.
+        Dimension of the constraint null space: :math:`n - r`.
     gauge_modes : int
         Number of rigid-body or unconstrained gauge degrees of freedom accounted for.
     relative_freedom : int
-        Effective design degrees of freedom: $\\max(0, \\mathrm{nullity} - \\mathrm{gauge\\_modes})$.
+        Effective design degrees of freedom: :math:`\max(0, \mathrm{nullity} - \mathrm{gauge\_modes})`.
     rank_tolerance : float
         Singular value cutoff threshold used to determine rank.
     is_licq_satisfied : bool
@@ -54,7 +54,8 @@ class FunctionNetwork:
     Coupled network of functions, multi-patch function sets, interfaces, and conditions.
 
     A FunctionNetwork represents the overall topological and algebraic assembly:
-    - Nodes: Function or FunctionSet patches $(f_i, \\mathrm{patch\\_id})$.
+
+    - Nodes: Function or FunctionSet patches :math:`(f_i, \\mathrm{patch\\_id})`.
     - Hyperedges: Interface objects coupling markers across patches.
     - Mechanics: InterfaceCondition objects enforcing algebraic residuals.
 
@@ -269,15 +270,20 @@ class FunctionNetwork:
         return internal, between
 
     def compute_cycle_rank(self) -> Tuple[int, int]:
-        """
-        Computes the first Betti number $b_1$ on the patch-level incidence multigraph:
-            $b_{1,\\mathrm{multigraph}} = |E_{\\mathrm{inc}}| - (|V_{\\mathrm{patches}}| + |V_{\\mathrm{interfaces}}|) + C$
+        r"""
+        Computes the first Betti number :math:`b_1` on the patch-level incidence multigraph:
+
+        .. math::
+
+            b_{1,\mathrm{multigraph}} = |E_{\mathrm{inc}}| - (|V_{\mathrm{patches}}| + |V_{\mathrm{interfaces}}|) + C
+
         and the macroscopic loop count after collapsing parallel edges between identical patch sets.
 
         Returns
         -------
         Tuple[int, int]
             (b1_multigraph, b1_macroscopic)
+
             - b1_multigraph counts all independent topological cycles including multi-point parallel attachments.
             - b1_macroscopic counts global topological loops between components.
         """

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/core/function_set.py

@@ -407,6 +407,7 @@ class FunctionSet:
         ----------
         parametric_coordinates : Optional[Union[tuple[int, npt.NDArray[np.float64]], list[tuple[int, npt.NDArray[np.float64]]]]]
             Direct parametric coordinates on the function set, specified as:
+
             - A tuple: (function_index, uv_array) for a single point.
             - Or a list of tuples: [(function_index, uv_array), ...] for one or more points.
         name : Optional[str]

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/core/interface.py

@@ -572,17 +572,18 @@ class InterfaceCondition:
 
 
 class CollocationCondition(InterfaceCondition):
-    """
+    r"""
     Collocation condition enforcing trace equality across markers, unary target planes, or prescribed offsets.
 
     Supports component selection per marker (e.g. constraining only x and z components)
-    and derivative matching for $C^1$ continuity.
+    and derivative matching for :math:`C^1` continuity.
 
     Formulation:
+
     - Multi-marker (star scheme against marker 0):
-      $r_k(\\gamma) = (f_k \\circ \\alpha_k)(\\gamma) - (f_0 \\circ \\alpha_0)(\\gamma) - \\mathrm{offset}$
+      :math:`r_k(\gamma) = (f_k \circ \alpha_k)(\gamma) - (f_0 \circ \alpha_0)(\gamma) - \mathrm{offset}`
     - Unary target:
-      $r_0(\\gamma) = (f_0 \\circ \\alpha_0)(\\gamma) - \\mathrm{target}$
+      :math:`r_0(\gamma) = (f_0 \circ \alpha_0)(\gamma) - \mathrm{target}`
 
     Parameters
     ----------
@@ -686,12 +687,13 @@ class CollocationCondition(InterfaceCondition):
 
 
 class TransversalDerivativeCondition(InterfaceCondition):
-    """
+    r"""
     Directional / transversal derivative matching condition across an Interface.
 
-    Enforces $C^1$ parametric derivative matching across patch boundaries:
+    Enforces :math:`C^1` parametric derivative matching across patch boundaries:
+
     - Multi-marker (star scheme against marker 0):
-      $r_k(\\gamma) = D_{d_k}(f_k \\circ \\alpha_k)(\\gamma) - \\mu_k D_{d_0}(f_0 \\circ \\alpha_0)(\\gamma)$
+      :math:`r_k(\gamma) = D_{d_k}(f_k \circ \alpha_k)(\gamma) - \mu_k D_{d_0}(f_0 \circ \alpha_0)(\gamma)`
 
     Parameters
     ----------
@@ -778,13 +780,15 @@ class TransversalDerivativeCondition(InterfaceCondition):
 
 
 class NormalAlignmentCondition(InterfaceCondition):
-    """
-    Surface normal alignment condition enforcing $G^1$ / tangent-plane continuity across an Interface.
+    r"""
+    Surface normal alignment condition enforcing :math:`G^1` / tangent-plane continuity across an Interface.
 
     Enforces that unit surface normal vectors align across patch boundaries:
+
     - Multi-marker (star scheme against marker 0):
-      $r_k(\\gamma) = n_k(\\gamma) - \\sigma n_0(\\gamma)$
-    where $\\sigma = \\pm 1$ represents relative surface orientation.
+      :math:`r_k(\gamma) = n_k(\gamma) - \sigma n_0(\gamma)`
+
+    where :math:`\sigma = \pm 1` represents relative surface orientation.
 
     Parameters
     ----------
@@ -865,10 +869,11 @@ class NormalAlignmentCondition(InterfaceCondition):
 
 
 class ClearanceCondition(InterfaceCondition):
-    """
+    r"""
     Clearance / non-penetration inequality condition across an Interface.
 
-    Enforces that the Euclidean distance between pairs of markers satisfies a minimum clearance:
+    Enforces that the Euclidean distance between pairs of markers satisfies a minimum clearance::
+
         ||f_k(gamma_k) - f_0(gamma_0)|| >= min_clearance
 
     Parameters
@@ -876,10 +881,13 @@ class ClearanceCondition(InterfaceCondition):
     interface : Interface
         The interface hyperedge containing the coupled markers (must have at least 2 markers).
     min_clearance : float
-        Minimum required physical clearance distance $d_{\\min} \\ge 0$. Default is 0.0.
+        Minimum required physical clearance distance :math:`d_{\min} \ge 0`. Default is 0.0.
     mode : Literal["violation", "margin"], optional
-        - "violation": evaluates $\\max(0, d_{\\min}^2 - \\|p_k - p_0\\|^2)$, which is zero when satisfied.
-        - "margin": evaluates $\\|p_k - p_0\\|^2 - d_{\\min}^2$, where $\\ge 0$ indicates satisfaction.
+        Evaluation mode:
+
+        - "violation": evaluates :math:`\max(0, d_{\min}^2 - \|p_k - p_0\|^2)`, which is zero when satisfied.
+        - "margin": evaluates :math:`\|p_k - p_0\|^2 - d_{\min}^2`, where :math:`\ge 0` indicates satisfaction.
+
         Default is "violation".
     discretization : Optional[Discretization], optional
         Discretization scheme for continuous interfaces. If None, uses interface.discretization.

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/core/marker.py

@@ -286,8 +286,10 @@ class Marker:
 
     def compute_boundary_violation(self) -> Optional[csdl.Variable]:
         """
-        Computes the quadratic box boundary violation penalty for variable parametric coordinates:
+        Computes the quadratic box boundary violation penalty for variable parametric coordinates::
+
             sum( relu(u_min - u)^2 + relu(u - u_max)^2 )
+
         Returns None if coordinates are numeric constant, or a scalar CSDL variable if variable.
         """
         if self.is_constant:

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/core/spaces/non_cython_bsplines/b_spline_patch_projection.py

@@ -23,8 +23,8 @@ def compute_projection_residual(
     """
     Compute the residual of the projection of a point in space onto a B-spline surface.
 
-    Parameters:
-    -----------
+    Parameters
+    ----------
     point_in_space : jnp.ndarray, shape (d,)
         The point in space to project.
     para_coords : jnp.ndarray, shape (M, d)
@@ -36,8 +36,8 @@ def compute_projection_residual(
     knot_vectors : tuple of jnp.ndarray
         Knot vectors for each dimension.
 
-    Returns:
-    --------
+    Returns
+    -------
     residual : jnp.ndarray, shape (M,)
         The residuals of the projection.
     """
@@ -88,8 +88,8 @@ def compute_projection_jacobian(
     """
     Compute the Jacobian of the projection of a point in space onto a B-spline surface.
 
-    Parameters:
-    -----------
+    Parameters
+    ----------
     point_in_space : jnp.ndarray, shape (d,)
         The point in space to project.
     para_coords : jnp.ndarray, shape (M, d)
@@ -105,8 +105,8 @@ def compute_projection_jacobian(
     surface_jacobian : list of jnp.ndarray, shape (M, num_phys_dims)
         Jacobian of the B-spline surface at the parameter coordinates.
 
-    Returns:
-    --------
+    Returns
+    -------
     jacobian : jnp.ndarray, shape (M, d)
         The Jacobian of the projection.
     """

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/core/spaces/non_cython_bsplines/b_spline_patch_projection_non_differentiable.py

@@ -12,8 +12,8 @@ def compute_projection_residual(
     """
     Compute the residual of the projection of a point in space onto a B-spline surface.
 
-    Parameters:
-    -----------
+    Parameters
+    ----------
     point_in_space : jnp.ndarray, shape (d,)
         The point in space to project.
     para_coords : jnp.ndarray, shape (M, d)
@@ -25,8 +25,8 @@ def compute_projection_residual(
     knot_vectors : tuple of jnp.ndarray
         Knot vectors for each dimension.
 
-    Returns:
-    --------
+    Returns
+    -------
     residual : jnp.ndarray, shape (M,)
         The residuals of the projection.
     """
@@ -73,8 +73,8 @@ def compute_projection_jacobian(
     """
     Compute the Jacobian of the projection of a point in space onto a B-spline surface.
 
-    Parameters:
-    -----------
+    Parameters
+    ----------
     point_in_space : jnp.ndarray, shape (d,)
         The point in space to project.
     para_coords : jnp.ndarray, shape (M, d)
@@ -90,8 +90,8 @@ def compute_projection_jacobian(
     surface_jacobian : list of jnp.ndarray, shape (M, num_phys_dims)
         Jacobian of the B-spline surface at the parameter coordinates.
 
-    Returns:
-    --------
+    Returns
+    -------
     jacobian : jnp.ndarray, shape (M, d)
         The Jacobian of the projection.
     """

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/core/spaces/non_cython_bsplines/b_spline_patch_projection_optimized.py

@@ -3,17 +3,20 @@
 Optimized B-spline surface projection (point -> parametric coords).
 
 Key features:
+
 1. High-efficiency Gauss-Newton / Levenberg-Marquardt (LM) distance minimization.
 2. JAX implementation (jit + vmap friendly).
 3. NumPy vectorized implementation.
 
 Algorithm overview:
+
 - Avoids second derivatives (surface Hessians) entirely.
-- Minimizes squared distance: f(xi) = 1/2 * || S(xi) - p ||^2.
-- Gauss-Newton step: (J^T J) delta = - J^T r.
-- LM step: (J^T J + lambda I) delta = - J^T r.
+- Minimizes squared distance: ``f(xi) = 1/2 * || S(xi) - p ||^2``.
+- Gauss-Newton step: ``(J^T J) delta = - J^T r``.
+- LM step: ``(J^T J + lambda I) delta = - J^T r``.
 
 Both implementations implement:
+
 - Box constraints via clipping.
 - Active-set masking near bounds.
 - Early stopping using convergence masks.
@@ -365,9 +368,11 @@ def make_projector_lm_numpy(
     """
     Factory returning evaluators for S(u) and partials using your stencil-based NumPy evaluator.
 
-    Returns:
-      eval_S(us, coeffs)      -> (M, phys_dim)
-      eval_partials(us, coeffs) -> (M, phys_dim, n_param)
+    Returns
+    -------
+    tuple
+        eval_S(us, coeffs) -> (M, phys_dim)
+        eval_partials(us, coeffs) -> (M, phys_dim, n_param)
     """
     if make_bspline_evaluator_numpy is None:
         raise ImportError("make_bspline_evaluator_numpy not found; ensure compute_basis_matrix_numpy_factory.py is on path.")

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/core/spaces/non_cython_bsplines/compute_basis_matrix_jax.py

@@ -147,8 +147,8 @@ def evaluate_b_spline_jax(us, degrees, knot_vectors, coeffs, der_orders=None):
     """
     Evaluate B-spline basis functions at parameter u with derivatives.
 
-    Parameters:
-    -----------
+    Parameters
+    ----------
     us : jnp.ndarray, shape (M, d)
         Parameter values where the B-spline basis functions are evaluated.
     degrees : tuple of int

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/core/spaces/non_cython_bsplines/compute_basis_matrix_jax_stencil.py

@@ -332,8 +332,8 @@ def evaluate_b_spline_jax(us, degrees, knot_vectors, coeffs, der_orders=None):
     """
     Evaluate B-spline basis functions at parameter u with derivatives.
 
-    Parameters:
-    -----------
+    Parameters
+    ----------
     us : jnp.ndarray, shape (M, d)
         Parameter values where the B-spline basis functions are evaluated.
     degrees : tuple of int

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/utils/file_io.py

@@ -1,12 +1,14 @@
 """STEP file importer (patched).
 
 Correctness fixes:
+
 - Robust entity parsing across line wraps (entities end with ';')
 - Correct float parsing for knots/control points (supports E/e and D/d exponents)
 - Correct knot expansion with multiplicities
 - Order-preserving control point lookup via id->xyz dictionary
 
 Performance improvements:
+
 - Single pass read: builds entity dict and point dict once
 - Avoids pandas and global regex scans
 - Caches BSplineSpace objects by a stable hash key
@@ -14,6 +16,7 @@ Performance improvements:
 Intended primarily for OpenVSP-exported STEP files containing B_SPLINE_SURFACE_WITH_KNOTS.
 
 Public API:
+
 - import_file(...)
 - _check_if_load_stored_import(...)
 """
@@ -233,7 +236,9 @@ def _detect_knot_fields(fields: List[str]) -> Tuple[List[int], List[int], List[f
 def _parse_bspline_surface_with_knots(rhs: str) -> Optional[Tuple[str, int, int, np.ndarray, List[int], List[int], List[float], List[float]]]:
     """Parse B_SPLINE_SURFACE_WITH_KNOTS entity RHS.
 
-    Returns:
+    Returns
+    -------
+    tuple
         (name, deg_u, deg_v, cp_id_grid, u_mults, v_mults, u_knots, v_knots)
     """
     if not rhs.startswith('B_SPLINE_SURFACE_WITH_KNOTS'):

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/lsdo_function_spaces/utils/plotting_functions.py

@@ -81,7 +81,7 @@ def show_plot(
     Shows the plot.
 
     Parameters
-    -----------
+    ----------
     plotting_elements : Optional[list]
         The list of PyVista plotting elements to plot. Default is None ([]).
     title : str
@@ -150,7 +150,7 @@ def plot_points(points:np.ndarray, opacity:float=1., color:Union[str, np.ndarray
     Plots a point cloud.
 
     Parameters
-    -----------
+    ----------
     points : np.ndarray
         The points to plot.
     opactity : float = 1.
@@ -201,7 +201,7 @@ def plot_curve(points:np.ndarray, opacity:float=1., color:Union[str, np.ndarray]
     Plots the B-spline Surface.
 
     Parameters
-    -----------
+    ----------
     points : np.ndarray -- shape=(num_points, num_physical_dimensions)
         The points of the curve to be plotted.
     opactity : float
@@ -253,7 +253,7 @@ def plot_surface(points:np.ndarray, plot_types:list=['function'], opacity:float=
     Plots the B-spline Surface.
 
     Parameters
-    -----------
+    ----------
     points : np.ndarray -- shape=(num_points_u, num_points_v, num_physical_dimensions)
         The type of points to be plotted. {evaluated_points, coefficients}
     plot_types : list

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1/lsdo_function_spaces.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lsdo_function_spaces
-Version: 1.2.0
+Version: 1.2.1
 Summary: A package for functional representation and function spaces in multidisciplinary design optimization.
 Author-email: Andrew Fletcher <afletcher168@gmail.com>
 License-Expression: Apache-2.0

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/pyproject.toml

@@ -30,7 +30,7 @@ dependencies = [
     'scikit-learn',
     'jax',
 ]
-version = "1.2.0"
+version = "1.2.1"
 
 [project.urls]
 Documentation = "https://lsdo-function-spaces.readthedocs.io/en/latest/"

{lsdo_function_spaces-1.2.0 → lsdo_function_spaces-1.2.1}/release_notes.md

@@ -1,5 +1,12 @@
 # Release Notes
 
+## lsdo_function_spaces 1.2.1 (November 2026)
+
+* **Documentation & Sphinx CI Fixes**: Corrected reST docstring formatting, list indentation, and LaTeX math syntax in `FunctionNetwork`, `CollocationCondition`, `NormalAlignmentCondition`, `TransversalDerivativeCondition`, `ClearanceCondition`, and `Marker` to resolve Sphinx `-W` build verification warnings on Python 3.11.
+* **Docstring Cleanups**: Normalized numpydoc section headers and underline lengths across core and utility modules.
+
+---
+
 ## lsdo_function_spaces 1.2.0 (November 2026)
 
 `lsdo_function_spaces` 1.2.0 introduces a comprehensive topological connectivity, semantic marker, and function network framework for multidisciplinary geometric modeling and optimization. This release establishes a mathematically rigorous separation between connectivity topology and constraint mechanics, supporting continuous and discrete multi-patch coupling, high-order continuity enforcement, automated seam discovery on CAD geometries, and algebraic freedom diagnostics via Singular Value Decomposition (SVD).