Polyphase Float User Guide and Reference
This is the reader's manual for the C library. It develops checked numerical programs, explains ownership and rounding, and provides a complete core API reference. Read the PDF edition, or download the HTML edition and open the saved file in a browser. The chapter files remain available for ordinary text reading and contributions.
The library remains beta and work in progress. For build commands, validation and release records, use the documentation index.
Start here
Numerical workflows
- Arithmetic and range
- Constants and intervals
- Elementary functions
- Special functions
- Numerical recipes
Application engineering
- Text and binary I/O
- Memory and overlap
- Threads and runtime state
- Integration and performance
- Troubleshooting
Reference material
- Numerical limits
- Every core function
- Types and named constants
- Glossary
- Checked example outputs
- Complete example programs
Rebuild the book
The library itself does not require a document toolchain. Rebuilding the book
requires Python 3, Pandoc, XeLaTeX, the fvextra, needspace, and fancyhdr
LaTeX packages, and the Bitstream Charter, Nimbus Sans, and DejaVu Sans Mono
fonts. To regenerate the mathematical illustrations, also install NumPy and
Matplotlib.
From the source root:
python3 tools/build_manual.py --output ../polyphase-manual
The command creates PDF, self-contained HTML with native MathML, and assembled
Markdown editions in the chosen directory. It reads the governed API records
and never modifies the production library. Add --skip-pdf when only the HTML
and Markdown editions are needed. The source chapter files and complete
programs remain the editable material.
The API page on GitHub uses ordinary Markdown headings so that its alphabetical index works there. To regenerate that page without building the book or installing Pandoc:
python3 tools/build_manual.py --github-reference docs/manual/API_REFERENCE.md
The book builder retains its explicit PDF and HTML anchors.