ruqu_algorithms/lib.rs
1//! # ruqu-algorithms -- Quantum Algorithm Implementations
2//!
3//! High-level quantum algorithms built on the `ruqu-core` simulation engine:
4//!
5//! - **VQE** (Variational Quantum Eigensolver): Find ground-state energies of
6//! molecular Hamiltonians using a classical-quantum hybrid loop with
7//! hardware-efficient ansatz and parameter-shift gradient descent.
8//!
9//! - **Grover's Search**: Quadratic speedup for unstructured search over N items,
10//! using amplitude amplification with direct state-vector oracle access.
11//!
12//! - **QAOA** (Quantum Approximate Optimization Algorithm): Approximate solutions
13//! to combinatorial optimization problems (MaxCut) via parameterized
14//! phase-separation and mixing layers.
15//!
16//! - **Surface Code**: Distance-3 surface code error correction simulation with
17//! stabilizer measurement cycles, noise injection, and syndrome decoding.
18//!
19//! # Quick Start
20//!
21//! ```rust,no_run
22//! use ruqu_algorithms::{VqeConfig, run_vqe, vqe::h2_hamiltonian};
23//!
24//! let config = VqeConfig {
25//! hamiltonian: h2_hamiltonian(),
26//! num_qubits: 2,
27//! ansatz_depth: 2,
28//! max_iterations: 100,
29//! convergence_threshold: 1e-6,
30//! learning_rate: 0.1,
31//! seed: Some(42),
32//! };
33//! let result = run_vqe(&config).expect("VQE failed");
34//! println!("Ground state energy: {:.6}", result.optimal_energy);
35//! ```
36
37pub mod grover;
38pub mod qaoa;
39pub mod surface_code;
40pub mod vqe;
41
42pub use grover::{GroverConfig, GroverResult, run_grover};
43pub use qaoa::{Graph, QaoaConfig, QaoaResult, run_qaoa};
44pub use surface_code::{SurfaceCodeConfig, SurfaceCodeResult, run_surface_code};
45pub use vqe::{VqeConfig, VqeResult, run_vqe};