API reference

API reference

Import poly for polynomial calculations. This reference groups operations by task; declarations and docstrings are rendered directly from source. Start with a tutorial if you are learning the workflow, or choose an operation below when you need its precise contract.

Topic Reference
Construction, shared conventions, budgets, and errors Array API
Arithmetic, calculus, division, gcds, factorization, interpolation, and elimination Dense arrays, sparse arrays
Retained evidence for division, gcds, resultants, factorization, and interpolation Checked exact results
Exact real and complex roots, root counts, and numerical root covers Root results and refinement
Real and complex algebraic numbers Exact algebraic values
Gröbner bases, reduction, and ideal membership Sparse arrays
Sign constraints, samples, and cylindrical decompositions CAD and sign constraints
Formal series, basis representations, and rational functions Series, bases, rational functions
Floating-point and ball coefficients Numerical coefficients
Certified evaluation and accuracy targets Certified evaluation
Maps, broadcasting, and reductions over batches Batch maps and broadcasting
Save complete values and shaped batches Value serialization

Read a signature in context

Each computational function has an overload that takes a mutable Budget and one that takes max_steps=; both raise PolyError. See errors and work limits. Numerical operations take an explicit context=. The domain guide lists the coefficient domains each kind of operation accepts.

Certificate checkers establish the relations described by their own contracts. Read certificate claims before treating an accepted product, identity, or enclosure as a stronger statement.

Developers extending the library can use the core API, which documents the containers and algorithms underneath poly.