docs.rs failed to build quantrs2-circuit-0.1.0-alpha.5
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build:
quantrs2-circuit-0.1.0-alpha.4
QuantRS2-Circuit: Advanced Quantum Circuit Framework
QuantRS2-Circuit is the comprehensive quantum circuit construction and optimization engine of the QuantRS2 quantum computing framework, providing advanced circuit representation, analysis, optimization, and compilation capabilities for quantum computing applications.
Core Features
Circuit Construction & Representation
- Fluent Builder API: Intuitive, chainable interface for quantum circuit construction
- Type-Safe Operations: Compile-time verification of qubit counts and gate operations
- DAG Representation: Directed acyclic graph representation for advanced circuit analysis
- Classical Control: Support for classical control flow, measurements, and feed-forward
- Mid-Circuit Measurements: Real-time measurement with conditional operations
Advanced Optimization Framework
- Multi-Pass Optimization: Configurable optimization pipeline with cost-aware scheduling
- Hardware-Aware Compilation: Device-specific optimization with noise models and constraints
- Gate Fusion: Intelligent gate merging for reduced circuit depth and gate count
- Template Matching: Pattern recognition for efficient gate sequence replacement
- Noise-Aware Optimization: Circuit optimization considering realistic device characteristics
Quantum Circuit Analysis
- Commutation Analysis: Automatic detection of commuting operations for reordering
- Circuit Equivalence: Verification of circuit equivalence using multiple methods
- Topological Analysis: Circuit connectivity and entanglement structure analysis
- Resource Estimation: Accurate resource counting and complexity analysis
- Performance Profiling: Detailed metrics for circuit optimization and execution
Hardware Integration
- Device Routing: SABRE and lookahead algorithms for qubit mapping and SWAP insertion
- Pulse-Level Control: Translation to pulse sequences for direct hardware control
- Crosstalk Mitigation: Scheduling algorithms to minimize gate crosstalk effects
- Calibration Integration: Real-time device calibration data incorporation
- Multi-Architecture Support: Superconducting, trapped ion, photonic, and topological systems
Usage Examples
Basic Circuit Construction
use *;
Advanced Optimization Pipeline
use *;
Hardware-Aware Compilation
use *;
Circuit Analysis and Verification
use *;
Classical Control and Measurement
use *;
Fault-Tolerant Circuit Compilation
use *;
QASM Import/Export
use *;
Comprehensive Module Structure
Core Circuit Framework
- builder.rs: Fluent circuit builder API with type-safe operations
- dag.rs: Directed acyclic graph representation for circuit analysis
- classical.rs: Classical control flow, conditional operations, and measurements
- measurement.rs: Mid-circuit measurements and feed-forward control
Optimization & Analysis
- optimization/: Comprehensive optimization framework
- pass_manager.rs: Configurable optimization pipeline management
- passes.rs: Individual optimization passes (gate cancellation, fusion, etc.)
- cost_model.rs: Hardware-aware cost models for optimization decisions
- analysis.rs: Circuit analysis and metric computation
- gate_properties.rs: Gate property analysis for optimization
- optimizer.rs: High-level circuit optimization interface
- graph_optimizer.rs: Graph-based optimization algorithms
- commutation.rs: Gate commutation analysis and reordering
- equivalence.rs: Circuit equivalence verification using multiple methods
Hardware Integration & Compilation
- routing/: Quantum circuit routing and layout algorithms
- sabre.rs: SABRE routing algorithm
- lookahead.rs: Lookahead routing for enhanced performance
- coupling_map.rs: Device topology representation and analysis
- swap_network.rs: SWAP gate insertion and optimization
- pulse.rs: Pulse-level control and waveform generation
- crosstalk.rs: Crosstalk analysis and mitigation scheduling
- topology.rs: Circuit topology analysis and optimization
Advanced Circuit Types
- fault_tolerant.rs: Fault-tolerant circuit compilation with error correction
- photonic.rs: Photonic quantum circuit representation and operations
- topological.rs: Topological quantum circuit compilation with anyons
Circuit Transformation & Synthesis
- synthesis.rs: Unitary synthesis and gate decomposition
- tensor_network.rs: Tensor network representation and compression
- zx_calculus.rs: ZX-diagram optimization and circuit extraction
- slicing.rs: Circuit slicing for parallel execution
Import/Export & Interoperability
- qasm/: QASM 2.0/3.0 support
- parser.rs: QASM parsing with full language support
- exporter.rs: Circuit export to QASM format
- ast.rs: Abstract syntax tree representation
- validator.rs: QASM validation and error checking
- simulator_interface.rs: Integration with various simulator backends
Machine Learning & Advanced Algorithms
- ml_optimization.rs: Machine learning-based circuit optimization
- scirs2_integration.rs: SciRS2 integration for graph algorithms and optimization
API Overview
Core Types
Circuit<N>
: Quantum circuit with const generic for qubit countSimulator
: Trait for backends that can run quantum circuits
Macros
circuit!
: Creates a new circuit with the specified number of qubitsqubits!
: Creates a set of qubits for operationsquantum!
: DSL for quantum circuit construction (in development)
Technical Details
- The circuit builder uses a fluent API for method chaining
- Gate operations are type-checked at compile time where possible
- The framework supports custom gates through the
GateOp
trait - Circuit operations return
QuantRS2Result
for error handling
Future Plans
See TODO.md for planned features.
Integration with Other QuantRS2 Modules
This module is designed to work seamlessly with:
- quantrs2-core: Uses core types and gates for circuit construction
- quantrs2-sim: Circuits can be executed on simulators
- quantrs2-device: Circuits can be transpiled and run on real hardware
License
This project is licensed under either:
at your option.