oracq package overview¶
The root package oracq re-exports the public API (143 names).
Names are grouped by their defining module; module titles link to the corresponding API page and members link to their full descriptions there.
Infrastructure API¶
- Toffoli / U3 / CZ lowering
oracq.infrastructure.backends.basis—export_toffoli_u3_cz- OriginIR-ext backend
oracq.infrastructure.backends.originir—OriginIRArtifact,export_originir,run_originir- PySparQ backend
oracq.infrastructure.backends.pysparq—run_pysparq,run_pysparq_rir- Quantikz circuit export
oracq.infrastructure.backends.quantikz—quantikz- Strict netlist export
oracq.infrastructure.backends.strict—StrictArtifact,export_strict- Module builder
- Resource estimation
oracq.infrastructure.estimate—ResourceEstimate,estimate_resources,OracleCall,RotationCounts- Register reference executor
oracq.infrastructure.execution—RegisterState,simulate- RIR objects
oracq.infrastructure.ir—VERSION,Adjoint,Bits,Call,Control,Load,Module,Primitive,Program,QRAM,Rational,Ref,Register,RegType,Repeat,Resource,SInt,Span,Store,UInt,ValidationError,fuse- Binding and capability analysis
oracq.infrastructure.linking—Binding,OracleRequirement,bind,capabilities,unresolved,BindingError,BindingReport,BindingResult,bind_with_report- Math-function compilation entry
oracq.infrastructure.mathfunc—compile_function,lower_math_ir- Python math-function frontend
oracq.infrastructure.mathfunc.frontend—FunctionCompileError- MIR objects
oracq.infrastructure.mathfunc.graph—Index,MathProgram- Math-function lowering
oracq.infrastructure.mathfunc.lowering—CompiledFunction- Math kernel generation
oracq.infrastructure.mathfunc.numeric—MathConfig- Native implementation registry
oracq.infrastructure.native—DynamicCppFactory,NativeRegistry- QRAM pointer-style read/write
- QRAM YAML memory format
oracq.infrastructure.qram_schema—dump_qram_yaml,load_qram_yaml,RegisteredQRAM,register_qram- RIR serialization
- Structural validation
oracq.infrastructure.validation—validate
Algorithms API¶
- Reversible arithmetic
oracq.algorithms.common.arithmetic—FixedFormat,arithmetic_native_registry,fixed_arithmetic- Algorithm contracts and reports
oracq.algorithms.input_model.contracts—AlgorithmContract,ResolvedInputs,ContractError,ContractIssue,ContractReport,InputRequirement,OracleCapabilities,OracleSpec,ProtocolContract,describe_oracle,requires- initial
oracq.algorithms.input_model.initial—ArrayInput,InitialInput,OracleInput,PreparedInitial,QRAMInput,QRAMInputConfig,UniformInput- QODE assembly interface
oracq.algorithms.input_model.ode—GeneratorInput,MatrixInput,ODELayout,ODEProblem,OracleGeneratorInput,PreparedGenerator,QRAMMatrixConfig,QRAMMatrixInput- Operator wrappers and basic composition
oracq.algorithms.input_model.operators—BlockEncoding,Generator,block_encoding,identity,linear_combination,pauli_x,product,scale,zero- Oracle declarations and implementations
oracq.algorithms.input_model.oracles—declare- PDE models and adapters
oracq.algorithms.input_model.pde—InitialLayout,PDEGrid,PDEProblem,UniformGrid1D,UnstructuredGrid,UnstructuredGridConfig- Quantum data structures (qsample and sample-and-query)
- Quantum linear systems
oracq.algorithms.qlss.qlss—BlockSystem,LinearSystem,QLSSProtocol,SolveResult,SparseSystem,SpectralPromise,QLSSSolver- KP quantum recommendation system
oracq.algorithms.qml.recommendation—KPRecommendationConfig,RecommendationResult,kp_recommendation,sigma_from_phase- QODE assembly interface
oracq.algorithms.qode.ode—QODESolver,QODEProblem,QODEProtocol- solver
oracq.algorithms.qode.solver—LinearODEMethod,ODECircuit,ODEConfig,ODEMethod,ODEResult,ODESolveInstance,PreparedODE,qode_solve- solver
oracq.algorithms.qpde.solver—PDECircuit,PDEMethod,PDEResult,PDESolveInstance,PreparedPDE,QHAMConfig,QHAMMethod,qpde_solve