Documentation
¶
Overview ¶
Package algorithm provides quantum algorithms and classical optimization.
The package is organized into focused subpackages:
Classical optimization and circuit primitives:
- algorithm/optim — classical optimizers (Nelder-Mead, SPSA, Adam, L-BFGS)
- algorithm/gradient — quantum gradient computation (parameter-shift, finite difference)
- algorithm/ansatz — parameterized circuit templates (RealAmplitudes, EfficientSU2)
Variational algorithms:
- algorithm/vqe — Variational Quantum Eigensolver
- algorithm/vqd — Variational Quantum Deflation (excited states)
- algorithm/qaoa — Quantum Approximate Optimization Algorithm
- algorithm/vqc — Variational Quantum Classifier and Quantum Kernel
Search and estimation:
- algorithm/grover — Grover's search algorithm
- algorithm/ampest — Amplitude Estimation (standard and iterative)
- algorithm/counting — Quantum Approximate Counting
Phase estimation and simulation:
- algorithm/qpe — Quantum Phase Estimation and QFT
- algorithm/trotter — Trotter-Suzuki Hamiltonian simulation
Textbook and advanced algorithms:
- algorithm/textbook — Bernstein-Vazirani, Deutsch-Jozsa, Simon's
- algorithm/shor — Shor's factoring algorithm
- algorithm/hhl — HHL linear systems solver
Error mitigation:
- algorithm/mitigation — error mitigation (ZNE, readout, Pauli twirling, DD, PEC, CDR, TREX)
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package ampest implements Quantum Amplitude Estimation.
|
Package ampest implements Quantum Amplitude Estimation. |
|
Package ansatz provides parameterized circuit templates for variational algorithms.
|
Package ansatz provides parameterized circuit templates for variational algorithms. |
|
Package counting implements Quantum Approximate Counting.
|
Package counting implements Quantum Approximate Counting. |
|
Package gradient provides quantum gradient computation methods.
|
Package gradient provides quantum gradient computation methods. |
|
Package grover implements Grover's quantum search algorithm.
|
Package grover implements Grover's quantum search algorithm. |
|
Package hhl implements the Harrow-Hassidim-Lloyd algorithm for solving linear systems of equations Ax = b on a quantum computer.
|
Package hhl implements the Harrow-Hassidim-Lloyd algorithm for solving linear systems of equations Ax = b on a quantum computer. |
|
internal
|
|
|
algoutil
Package algoutil provides shared helper functions for the algorithm subpackages.
|
Package algoutil provides shared helper functions for the algorithm subpackages. |
|
Package mitigation provides quantum error mitigation techniques for NISQ devices.
|
Package mitigation provides quantum error mitigation techniques for NISQ devices. |
|
Package optim provides classical optimization algorithms.
|
Package optim provides classical optimization algorithms. |
|
Package qaoa implements the Quantum Approximate Optimization Algorithm.
|
Package qaoa implements the Quantum Approximate Optimization Algorithm. |
|
Package qpe implements Quantum Phase Estimation.
|
Package qpe implements Quantum Phase Estimation. |
|
Package shor implements Shor's quantum factoring algorithm.
|
Package shor implements Shor's quantum factoring algorithm. |
|
Package textbook implements textbook quantum algorithms: Bernstein-Vazirani, Deutsch-Jozsa, and Simon's algorithm.
|
Package textbook implements textbook quantum algorithms: Bernstein-Vazirani, Deutsch-Jozsa, and Simon's algorithm. |
|
Package trotter implements Trotter-Suzuki Hamiltonian simulation.
|
Package trotter implements Trotter-Suzuki Hamiltonian simulation. |
|
Package vqc implements the Variational Quantum Classifier.
|
Package vqc implements the Variational Quantum Classifier. |
|
Package vqd implements the Variational Quantum Deflation algorithm.
|
Package vqd implements the Variational Quantum Deflation algorithm. |
|
Package vqe implements the Variational Quantum Eigensolver.
|
Package vqe implements the Variational Quantum Eigensolver. |
Click to show internal directories.
Click to hide internal directories.