Source code for nurbs.functions

from __future__ import annotations

from copy import copy
from typing import Tuple, Union

import numpy as np

from compmec.nurbs import heavy
from compmec.nurbs.__classes__ import Intface_BaseFunction, Intface_Evaluator
from compmec.nurbs.knotspace import KnotVector


class BaseFunction(Intface_BaseFunction):
    def __init__(self, knotvector: KnotVector):
        self.knotvector = knotvector
        self.weights = None

    def __eq__(self, other: Intface_BaseFunction) -> bool:
        if not isinstance(other, Intface_BaseFunction):
            return False
        if self.knotvector != other.knotvector:
            return False
        weightleft = self.weights
        weightrigh = other.weights
        weightleft = np.ones(self.npts) if self.weights is None else self.weights
        weightrigh = np.ones(self.npts) if weightrigh is None else weightrigh
        return np.all(weightleft == weightrigh)

    def __ne__(self, other: Intface_BaseFunction) -> bool:
        return not self.__eq__(other)

    def __call__(self, nodes: Union[float, np.ndarray]) -> Union[float, np.ndarray]:
        return self.eval(nodes)

    @property
    def knotvector(self) -> KnotVector:
        """The knotvector of the current basis function

        :getter: knotvector of current basis function
        :setter: -
        :type: KnotVector

        Example use
        -----------

        >>> from compmec.nurbs import KnotVector
        >>> knotvector = KnotVector([0, 0, 2, 3, 3])
        >>> basis = Function(knotvector)
        >>> basis.knotvector
        (0, 0, 2, 3, 3)
        >>> type(basis.knotvector)
        <class 'compmec.nurbs.knotspace.KnotVector'>

        """
        return self.__knotvector

    @property
    def degree(self) -> int:
        """Polynomial degree of basis function

        :getter: The polynomial degree
        :setter: -
        :type: int

        Example use
        -----------

        >>> from compmec.nurbs import KnotVector
        >>> knotvector = KnotVector([0, 0, 2, 3, 3])
        >>> basis = Function(knotvector)
        >>> basis.degree
        1

        """
        return self.knotvector.degree

    @property
    def npts(self) -> int:
        """Number of control points

        :getter: The number of control points
        :setter: -
        :type: int

        Example use
        -----------

        >>> from compmec.nurbs import KnotVector
        >>> knotvector = KnotVector([0, 0, 2, 3, 3])
        >>> basis = Function(knotvector)
        >>> basis.npts
        3

        """
        return self.knotvector.npts

    @property
    def knots(self) -> Tuple[float]:
        """The knots of the knotvector

        :getter: knot of the knotvector
        :setter: -
        :type: tuple[float]

        Example use
        -----------

        >>> from compmec.nurbs import KnotVector
        >>> knotvector = KnotVector([0, 0, 2, 3, 3])
        >>> basis = Function(knotvector)
        >>> basis.knots
        (0, 2, 3)

        """
        return self.knotvector.knots

    @property
    def weights(self) -> Union[Tuple[float], None]:
        """Weights of the current function. If it's ``None``, it means
        the basis function is not rational

        :getter: Returns the tuple of the weights, or None if there are no weights
        :setter: Set the weights of rational bspline basis functions
        :type: None | tuple[float]

        Example use
        -----------

        >>> from compmec.nurbs import KnotVector
        >>> knotvector = KnotVector([0, 0, 2, 3, 3])
        >>> basis = Function(knotvector)
        >>> basis.weights
        None

        >>> basis.weights = [1, 2, 1]
        >>> basis.weights
        (1, 2, 1)

        """
        return self.__weights

    @degree.setter
    def degree(self, value: int):
        value = int(value)
        self.knotvector.degree = value

    @knotvector.setter
    def knotvector(self, value: KnotVector):
        self.__knotvector = KnotVector(value)

    @weights.setter
    def weights(self, value: Tuple[float]):
        if value is None:
            self.__weights = None
            return
        value = np.array(value, dtype="object")
        if not np.all(value > 0):
            error_msg = "All weights must be positive!"
            raise ValueError(error_msg)
        if value.shape != (self.npts,):
            error_msg = f"Weights shape invalid! {value.shape} != ({self.npts})"
            raise ValueError(error_msg)
        self.__weights = value

    def __copy__(self) -> BaseFunction:
        return self.__deepcopy__(None)

    def __deepcopy__(self, memo) -> BaseFunction:
        knotvector = copy(self.knotvector)
        newfunc = self.__class__(knotvector)
        if self.weights is not None:
            newfunc.weights = [copy(weight) for weight in self.weights]
        return newfunc


class FunctionEvaluator(Intface_Evaluator):
    def __init__(self, func: BaseFunction, i: Union[int, slice], j: int):
        vector = func.knotvector
        self.__knotvector = vector
        self.__weights = func.weights
        self.__first_index = i
        self.__second_index = j
        self.__matrix = heavy.BasisFunction.speval_matrix(vector.internal, j)
        self.__knots = vector.knots
        self.__spans = vector.span(vector.knots)

    def __compute_vector_spline(self, node: float, span: int) -> np.ndarray:
        """
        Given a 'u' float, it returns the vector with all Spline Basis Functions:
        compute_vector(u, span) = [N_{0j}(u), N_{1j}(u), ..., N_{npts-1,j}(u)]
        """
        npts = self.__knotvector.npts
        result = [0 * node] * npts
        z = self.__spans.index(span)
        denom = self.__knots[z + 1] - self.__knots[z]
        shifnode = (node - self.__knots[z]) / denom
        for y in range(self.__second_index + 1):
            i = y + span - self.__second_index
            for k in range(self.__second_index, -1, -1):
                result[i] *= shifnode
                result[i] += self.__matrix[z][y][k]
        return result

    def __compute_vector(self, node: float, span: int) -> np.ndarray:
        """
        Given a 'u' float, it returns the vector with all BasicFunctions:
        compute_vector(u, span) = [F_{0j}(u), F_{1j}(u), ..., F_{npts-1,j}(u)]
        """
        result = self.__compute_vector_spline(node, span)
        if self.__weights is None:
            return result
        return self.__weights * result / np.inner(self.__weights, result)

    def __compute_matrix(
        self, nodes: Tuple[float], spans: Tuple[int]
    ) -> Tuple[Tuple[float]]:
        """
        Receives an 1D array of nodes, and returns a 2D array.
        nodes.shape = (len(nodes), )
        result.shape = (npts, len(nodes))
        """
        nodes = tuple(nodes)
        npts = self.__knotvector.npts
        matrix = np.empty((npts, len(nodes)), dtype="object")
        for j, (nodej, spanj) in enumerate(zip(nodes, spans)):
            values = self.__compute_vector(nodej, spanj)
            for i in range(npts):
                matrix[i][j] = values[i]
        matrix = matrix.tolist()
        for i, line in enumerate(matrix):
            matrix[i] = tuple(line)
        return tuple(matrix)

    def __eval(self, nodes: Tuple[float]) -> Tuple[Tuple[float]]:
        """
        Private and unprotected method of eval
        """
        nodes = tuple(nodes)
        spans = self.__knotvector.span(nodes)
        matrix = self.__compute_matrix(nodes, spans)
        return matrix

    def eval(
        self, nodes: Union[float, Tuple[float]]
    ) -> Union[float, Tuple[float], Tuple[Tuple[float]]]:
        """
        If i is integer, u is float -> float
        If i is integer, u is Tuple[float], ndim = k -> np.ndarray, ndim = k
        If i is slice, u is float -> Tuple[float]
        if i is slice, u is Tuple[float], ndim = k -> Tuple[Tuple[float]], ndim = k+1
        """
        singlenode = True
        try:
            iter(nodes)
            singlenode = False
        except TypeError:
            nodes = (nodes,)
        matrix = self.__eval(nodes)
        if singlenode:
            matrix = tuple([ri[0] for ri in matrix])
        result = matrix[self.__first_index]
        return result

    def __call__(
        self, nodes: Union[float, Tuple[float]]
    ) -> Union[float, Tuple[float], Tuple[Tuple[float]]]:
        return self.eval(nodes)


class IndexableFunction(BaseFunction):
    """
    Allows BaseFunction to be indexable
    """

    def __init__(self, knotvector: KnotVector):
        super().__init__(knotvector)

    def __valid_first_index(self, index: Union[int, slice]):
        if not isinstance(index, (int, slice)):
            raise TypeError
        if isinstance(index, int):
            npts = self.npts
            if not (-npts <= index < npts):
                raise IndexError

    def __valid_second_index(self, index: int):
        if not isinstance(index, int):
            raise TypeError
        if not (0 <= index <= self.degree):
            error_msg = f"Second index (={index}) "
            error_msg += f"must be in [0, {self.degree}]"
            raise IndexError(error_msg)

    def __getitem__(self, index) -> FunctionEvaluator:
        if isinstance(index, tuple):
            if len(index) > 2:
                raise IndexError
            i, j = index
        else:
            i, j = index, self.degree
        self.__valid_first_index(i)
        self.__valid_second_index(j)
        return FunctionEvaluator(self, i, j)

    def eval(self, nodes: Union[float, np.ndarray]) -> Union[float, np.ndarray]:
        """Evaluate the given nodes"""
        evaluator = self[:, self.degree]
        return evaluator(nodes)


[docs] class Function(IndexableFunction): """Basis Function class, to evaluate functions Example use ----------- >>> import numpy as np >>> from compmec.nurbs import Function >>> knotvector = [0, 0, 1, 1] >>> basis = Function(knotvector) >>> basis.degree 1 >>> basis.npts 2 >>> basis(0.5) # same as basis[:, degree](0.5) (0.5, 0.5) >>> basis([0, 0.5, 1]) ((0, 0.5, 1), (1, 0.5, 0)) """ def __repr__(self) -> str: """Official printing""" if self.npts == self.degree + 1: return f"Bezier function of degree {self.degree}" elif self.weights is None: msg = "Spline" else: msg = "Rational" msg += f" function of degree {self.degree} " msg += f"and {self.npts} points" return msg