API Reference¶
API pages are generated from the canonical source paths. Two legacy modules hold live implementations behind compatibility names — oracq.applications.legacy and oracq.algorithms.qode.legacy — and therefore keep generated pages; pure re-export shims such as oracq.qham are not listed twice.
- oracq package overview
- Infrastructure API
- Toffoli / U3 / CZ lowering
- OriginIR-ext backend
- PySparQ backend
- Quantikz circuit export
- Strict netlist export
- Module builder
- Resource estimation
- Register reference executor
- RIR objects
- Register layout
- Binding and capability analysis
- Math-function compilation entry
- Python math-function frontend
- MIR objects
- Math-function lowering
- Math kernel generation
- Native implementation registry
- QRAM pointer-style read/write
- QRAM YAML memory format
- Host readout
- RIR serialization
- Structural validation
- Algorithms API
- Modular multiplication and order finding
- Oracle query algorithms
- Reversible arithmetic
- Phase, amplitude, and overlap estimation
- Fourier transforms and arithmetic
- Hamiltonian evolution
- Quantum summation and integration
- PREPARE-SELECT decomposition
- qsp_pyqsp
- QSVT standard transforms
- Search and amplitude amplification
- solve
- Operator-level synthesis optimization of spectral circuits
- State-preparation composition
- Matrix transform sequences
- Quantum walks
- Block-encoding composition
- Algorithm contracts and reports
- Select-Swap QROM data loading
- Density-matrix input models and Gibbs states
- Graph-walk search
- initial
- Algorithm structure protocols
- Chemistry low-rank decomposition block encodings
- QODE assembly interface
- Operator wrappers and basic composition
- Oracle declarations and implementations
- PDE models and adapters
- Quantum data structures (qsample and sample-and-query)
- QHAM
- Sparse-access adapters
- Spectral input/output primitives and operator-level optimization
- DQI decoding quantum interference optimization
- Quantum gradient estimation
- Variational algorithm circuits
- Repetition codes and error recovery
- Quantum linear systems
- VTAA-CKS variable-time linear-system solver
- Quantum convolutional neural networks
- Quantum building blocks of QCNNs
- QPCA quantum principal component analysis
- Quantum semidefinite programming framework
- KP quantum recommendation system
- Carleman linearization
- Quantum Newton method
- CBMD
- LCHS
- Legacy compatibility entry points
- QODE assembly interface
- Linear ODE input models
- Schrödingerization
- SDE/Fokker–Planck input models
- solver
- PDE models and adapters
- solver
- Domain Applications API
- Reference workload catalog
- Flow fields and QRAM data
- Algorithm gallery
- Legacy compatibility entry points
- oracle_study
- QFVM application
- QFVM direct QMem data path
- QHAM PDE examples
- QHAM finite closure
- PDE models and adapters
- Spatial discretization and classical reference
- QHAM derivation report
- Structured finite-difference ports
- Roe matrix-element generation
- Roe classical math formulas