Internal API#

This section contains the documentation for all low-level functions and numerical routines that support the high-level constructs of Minterpy (e.g., Grid, MultiIndexSet, LagrangePolynomial, NewtonPolynomial).

These functions typically operate on low-level data structures, such as NumPy arrays or lists.

The internal utility functions in the Minterpy codebase are categorized into two main types:

  • Non-compiled internal functions

  • Compiled (accelerated) internal functions

For several performance-critical numerical routines, Minterpy leverages Numba to compile the code just-in-time, significantly accelerating runtime performance.

Warning

While these functions are publicly documented, due to their lower-level nature they may subject to sudden changes with each Minterpy release. The development team does not guarantee the stability of these function interfaces and reserves the right to modify them as needed.

Module / Sub-package

Description

Non-Compiled

Utility sub-package used across Minterpy (without compilation)

JIT-Compiled

Just-in-time compiled numerical routines

DDS

Implementation of the multivariate divided difference scheme

Transformation Utilities

Utility module with routines to compute transformation matrices

Generating Points

Utility module with routines to generate interpolation points