Polyphase Float documentation
Polyphase Float is beta and work in progress. Start with the manual for an introduction, or choose a guide for the task you want to complete.
Read and use the library
| Task | Start here |
|---|---|
| Learn the library | Manual and chapter list |
| Read the book as a PDF | User Guide and Reference |
| Read offline | HTML edition, then use GitHub's download button and open the saved file in a browser |
| Build and install | Building |
| Find a function | Core API reference |
| Run complete examples | Example programs, recorded outputs |
| Check input limits and failure behavior | Release scope, numerical limits |
| Understand memory and threads | Aliasing, thread safety |
| Integrate the installed library | CMake setup, ABI policy |
The supported build baseline is Linux x86-64 with LP64 and 64-bit GMP limbs. The installation chapter explains the Linux shell setup for Windows readers using WSL.
Check results and prepare a release
| Task | Start here |
|---|---|
| Choose and run tests | Testing |
| Reproduce the Linux validation matrix | Qualification |
| Assess a reported result | Claims and evidence |
| Prepare source archives | Release process |
| Publish reviewed artifacts | GitHub release procedure |
| Find the remaining work | 1.0 readiness, roadmap |
| Read earlier records | History index, release notes |
The manual explains how to use the library. Validation records describe the source, environment and inputs checked by a particular run. Consult both when deciding whether a result applies to your application.