quriust/lib.rs
1//! # Quantum Computer Simulation Library
2//!
3//! This library provides a framework for simulating quantum computers using classical computers.
4//!
5//! ## Modules
6//!
7//! - `algorithms`: Contains implementations of various quantum algorithms.
8//! - `registers`: Defines data structures for quantum registers.
9//! - `state`: Implements the quantum state and operations on it.
10//!
11//! ## Example
12//!
13//! ```rust
14//! use quriust::registers::{ClassicalRegister, QuantumRegister};
15//! // Create a new quantum register
16//! let classical_register: ClassicalRegister = ClassicalRegister::from_value(4, 1);
17//! let mut register = QuantumRegister::new(&classical_register);
18//!
19//! // Apply a Hadamard gate to the first qubit
20//! register.h(1);
21//!
22//! // Measure the register
23//! let measurement = register.measure();
24//!
25//! // Print the measurement outcome
26//! println!("Measurement outcome: {:?}", measurement);
27//! ```
28
29pub mod algorithms;
30pub mod registers;
31pub mod state;
32pub mod quantum_computer;