ruqu_core/lib.rs
1//! # ruqu-core -- Quantum Simulation Engine
2//!
3//! Pure Rust state-vector quantum simulator for the ruVector stack.
4//! Supports up to 25 qubits, common gates, measurement, noise models,
5//! and expectation value computation.
6//!
7//! ## Quick Start
8//!
9//! ```
10//! use ruqu_core::prelude::*;
11//!
12//! // Create a Bell state |00> + |11> (unnormalised notation)
13//! let mut circuit = QuantumCircuit::new(2);
14//! circuit.h(0).cnot(0, 1);
15//! let result = Simulator::run(&circuit).unwrap();
16//! let probs = result.state.probabilities();
17//! // probs ~= [0.5, 0.0, 0.0, 0.5]
18//! ```
19
20pub mod types;
21pub mod error;
22pub mod gate;
23pub mod state;
24pub mod circuit;
25pub mod simulator;
26pub mod optimizer;
27
28/// Re-exports of the most commonly used items.
29pub mod prelude {
30 pub use crate::types::*;
31 pub use crate::error::{QuantumError, Result};
32 pub use crate::gate::Gate;
33 pub use crate::state::QuantumState;
34 pub use crate::circuit::QuantumCircuit;
35 pub use crate::simulator::{SimConfig, SimulationResult, Simulator, ShotResult};
36}