quantrs2-sim 0.1.3

Quantum circuit simulators for the QuantRS2 framework
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
//! Enhanced Quantum Reservoir Computing Framework - Ultrathink Mode Implementation
//!
//! This module provides a comprehensive implementation of quantum reservoir computing (QRC),
//! a cutting-edge computational paradigm that leverages the high-dimensional, nonlinear
//! dynamics of quantum systems for temporal information processing and machine learning.
//! This ultrathink mode implementation includes advanced learning algorithms, sophisticated
//! reservoir topologies, real-time adaptation, and comprehensive analysis tools.
//!
//! ## Core Features
//! - **Advanced Quantum Reservoirs**: Multiple sophisticated architectures including scale-free,
//!   hierarchical, modular, and adaptive topologies
//! - **Comprehensive Learning Algorithms**: Ridge regression, LASSO, Elastic Net, RLS, Kalman
//!   filtering, neural network readouts, and meta-learning approaches
//! - **Time Series Modeling**: ARIMA-like capabilities, nonlinear autoregressive models,
//!   memory kernels, and temporal correlation analysis
//! - **Real-time Adaptation**: Online learning algorithms with forgetting factors, plasticity
//!   mechanisms, and adaptive reservoir modification
//! - **Memory Analysis Tools**: Quantum memory capacity estimation, nonlinear memory measures,
//!   temporal information processing capacity, and correlation analysis
//! - **Hardware-aware Optimization**: Device-specific compilation, noise-aware training,
//!   error mitigation, and platform-specific optimizations
//! - **Comprehensive Benchmarking**: Multiple datasets, statistical significance testing,
//!   comparative analysis, and performance validation frameworks
//! - **Advanced Quantum Dynamics**: Unitary evolution, open system dynamics, NISQ simulation,
//!   adiabatic processes, and quantum error correction integration

mod analysis;
mod config;
mod reservoir;
mod state;
mod time_series;
pub mod types;

// Re-export all public types
pub use analysis::*;
pub use config::*;
pub use reservoir::*;
pub use state::*;
pub use time_series::*;
pub use types::*;

use crate::error::Result;
use scirs2_core::ndarray::Array1;
use std::collections::HashMap;

/// Comprehensive benchmark for enhanced quantum reservoir computing
pub fn benchmark_enhanced_quantum_reservoir_computing() -> Result<HashMap<String, f64>> {
    let mut results = HashMap::new();

    // Test different enhanced reservoir configurations
    let configs = vec![
        QuantumReservoirConfig {
            num_qubits: 6,
            architecture: QuantumReservoirArchitecture::RandomCircuit,
            learning_config: AdvancedLearningConfig {
                algorithm: LearningAlgorithm::Ridge,
                ..Default::default()
            },
            ..Default::default()
        },
        QuantumReservoirConfig {
            num_qubits: 8,
            architecture: QuantumReservoirArchitecture::ScaleFree,
            learning_config: AdvancedLearningConfig {
                algorithm: LearningAlgorithm::LASSO,
                ..Default::default()
            },
            ..Default::default()
        },
        QuantumReservoirConfig {
            num_qubits: 6,
            architecture: QuantumReservoirArchitecture::HierarchicalModular,
            learning_config: AdvancedLearningConfig {
                algorithm: LearningAlgorithm::RecursiveLeastSquares,
                ..Default::default()
            },
            memory_config: MemoryAnalysisConfig {
                enable_capacity_estimation: true,
                enable_nonlinear: true,
                ..Default::default()
            },
            ..Default::default()
        },
        QuantumReservoirConfig {
            num_qubits: 8,
            architecture: QuantumReservoirArchitecture::Grid,
            dynamics: ReservoirDynamics::Floquet,
            input_encoding: InputEncoding::Angle,
            output_measurement: OutputMeasurement::TemporalCorrelations,
            ..Default::default()
        },
    ];

    for (i, config) in configs.into_iter().enumerate() {
        let start = std::time::Instant::now();

        let mut qrc = QuantumReservoirComputerEnhanced::new(config)?;

        // Generate enhanced test data
        let training_data = ReservoirTrainingData::new(
            (0..200)
                .map(|i| {
                    Array1::from_vec(vec![
                        (f64::from(i) * 0.1).sin(),
                        (f64::from(i) * 0.1).cos(),
                        (f64::from(i) * 0.05).sin() * (f64::from(i) * 0.2).cos(),
                    ])
                })
                .collect(),
            (0..200)
                .map(|i| Array1::from_vec(vec![f64::from(i).mul_add(0.1, 1.0).sin()]))
                .collect(),
            (0..200).map(|i| f64::from(i) * 0.1).collect(),
        );

        // Train and test
        let training_result = qrc.train(&training_data)?;

        let time = start.elapsed().as_secs_f64() * 1000.0;
        results.insert(format!("enhanced_config_{i}"), time);

        // Add enhanced performance metrics
        let metrics = qrc.get_metrics();
        results.insert(
            format!("enhanced_config_{i}_accuracy"),
            metrics.prediction_accuracy,
        );
        results.insert(
            format!("enhanced_config_{i}_memory_capacity"),
            training_result.memory_capacity,
        );
        results.insert(
            format!("enhanced_config_{i}_nonlinear_capacity"),
            training_result.nonlinear_capacity,
        );
        results.insert(
            format!("enhanced_config_{i}_processing_capacity"),
            training_result.processing_capacity,
        );
        results.insert(
            format!("enhanced_config_{i}_quantum_advantage"),
            metrics.quantum_advantage,
        );
        results.insert(
            format!("enhanced_config_{i}_efficiency"),
            metrics.reservoir_efficiency,
        );

        // Memory analysis results
        let memory_analyzer = qrc.get_memory_analysis();
        if let Some(&linear_capacity) = memory_analyzer.capacity_estimates.get("linear") {
            results.insert(
                format!("enhanced_config_{i}_linear_memory"),
                linear_capacity,
            );
        }
        if let Some(&total_capacity) = memory_analyzer.capacity_estimates.get("total") {
            results.insert(format!("enhanced_config_{i}_total_memory"), total_capacity);
        }
    }

    Ok(results)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_enhanced_quantum_reservoir_creation() {
        let config = QuantumReservoirConfig::default();
        let qrc = QuantumReservoirComputerEnhanced::new(config);
        assert!(qrc.is_ok());
    }

    #[test]
    fn test_enhanced_reservoir_state_creation() {
        let state = QuantumReservoirState::new(3, 10);
        assert_eq!(state.state_vector.len(), 8); // 2^3
        assert_eq!(state.state_history.capacity(), 10);
        assert_eq!(state.time_index, 0);
        assert!(state.memory_metrics.total_capacity >= 0.0);
    }

    #[test]
    fn test_enhanced_input_processing() {
        let config = QuantumReservoirConfig {
            num_qubits: 3,
            evolution_steps: 2,
            ..Default::default()
        };
        let mut qrc = QuantumReservoirComputerEnhanced::new(config).expect("Failed to create QRC");

        let input = Array1::from_vec(vec![0.5, 0.3, 0.8]);
        let result = qrc.process_input(&input);
        assert!(result.is_ok());

        let features = result.expect("Failed to process input");
        assert!(!features.is_empty());
    }

    #[test]
    fn test_enhanced_architectures() {
        let architectures = vec![
            QuantumReservoirArchitecture::RandomCircuit,
            QuantumReservoirArchitecture::SpinChain,
            QuantumReservoirArchitecture::ScaleFree,
            QuantumReservoirArchitecture::HierarchicalModular,
            QuantumReservoirArchitecture::Ring,
            QuantumReservoirArchitecture::Grid,
        ];

        for arch in architectures {
            let config = QuantumReservoirConfig {
                num_qubits: 4,
                architecture: arch,
                evolution_steps: 2,
                ..Default::default()
            };

            let qrc = QuantumReservoirComputerEnhanced::new(config);
            assert!(qrc.is_ok(), "Failed for architecture: {arch:?}");
        }
    }

    #[test]
    fn test_advanced_learning_algorithms() {
        let algorithms = vec![
            LearningAlgorithm::Ridge,
            LearningAlgorithm::LASSO,
            LearningAlgorithm::ElasticNet,
            LearningAlgorithm::RecursiveLeastSquares,
        ];

        for algorithm in algorithms {
            let config = QuantumReservoirConfig {
                num_qubits: 3,
                learning_config: AdvancedLearningConfig {
                    algorithm,
                    ..Default::default()
                },
                ..Default::default()
            };

            let qrc = QuantumReservoirComputerEnhanced::new(config);
            assert!(qrc.is_ok(), "Failed for algorithm: {algorithm:?}");
        }
    }

    #[test]
    fn test_enhanced_encoding_methods() {
        let encodings = vec![
            InputEncoding::Amplitude,
            InputEncoding::Phase,
            InputEncoding::BasisState,
            InputEncoding::Angle,
        ];

        for encoding in encodings {
            let config = QuantumReservoirConfig {
                num_qubits: 3,
                input_encoding: encoding,
                ..Default::default()
            };
            let mut qrc =
                QuantumReservoirComputerEnhanced::new(config).expect("Failed to create QRC");

            let input = Array1::from_vec(vec![0.5, 0.3]);
            let result = qrc.encode_input(&input);
            assert!(result.is_ok(), "Failed for encoding: {encoding:?}");
        }
    }

    #[test]
    fn test_enhanced_measurement_strategies() {
        let measurements = vec![
            OutputMeasurement::PauliExpectation,
            OutputMeasurement::Probability,
            OutputMeasurement::Correlations,
            OutputMeasurement::Entanglement,
            OutputMeasurement::QuantumFisherInformation,
            OutputMeasurement::Variance,
            OutputMeasurement::QuantumCoherence,
            OutputMeasurement::Purity,
            OutputMeasurement::TemporalCorrelations,
        ];

        for measurement in measurements {
            let config = QuantumReservoirConfig {
                num_qubits: 3,
                output_measurement: measurement,
                ..Default::default()
            };

            let qrc = QuantumReservoirComputerEnhanced::new(config);
            assert!(qrc.is_ok(), "Failed for measurement: {measurement:?}");
        }
    }

    #[test]
    fn test_enhanced_reservoir_dynamics() {
        let dynamics = vec![
            ReservoirDynamics::Unitary,
            ReservoirDynamics::Open,
            ReservoirDynamics::NISQ,
            ReservoirDynamics::Floquet,
        ];

        for dynamic in dynamics {
            let config = QuantumReservoirConfig {
                num_qubits: 3,
                dynamics: dynamic,
                evolution_steps: 1,
                ..Default::default()
            };

            let mut qrc =
                QuantumReservoirComputerEnhanced::new(config).expect("Failed to create QRC");
            let result = qrc.evolve_reservoir();
            assert!(result.is_ok(), "Failed for dynamics: {dynamic:?}");
        }
    }

    #[test]
    fn test_memory_analysis() {
        let config = QuantumReservoirConfig {
            num_qubits: 4,
            memory_config: MemoryAnalysisConfig {
                enable_capacity_estimation: true,
                enable_nonlinear: true,
                enable_ipc: true,
                ..Default::default()
            },
            ..Default::default()
        };

        let qrc = QuantumReservoirComputerEnhanced::new(config).expect("Failed to create QRC");
        let memory_analyzer = qrc.get_memory_analysis();

        assert!(memory_analyzer.config.enable_capacity_estimation);
        assert!(memory_analyzer.config.enable_nonlinear);
        assert!(memory_analyzer.config.enable_ipc);
    }

    #[test]
    fn test_enhanced_training_data() {
        let training_data = ReservoirTrainingData::new(
            vec![
                Array1::from_vec(vec![0.1, 0.2]),
                Array1::from_vec(vec![0.3, 0.4]),
            ],
            vec![Array1::from_vec(vec![0.5]), Array1::from_vec(vec![0.6])],
            vec![0.0, 1.0],
        )
        .with_features(vec![
            Array1::from_vec(vec![0.7, 0.8]),
            Array1::from_vec(vec![0.9, 1.0]),
        ])
        .with_labels(vec![0, 1])
        .with_weights(vec![1.0, 1.0]);

        assert_eq!(training_data.len(), 2);
        assert!(training_data.features.is_some());
        assert!(training_data.labels.is_some());
        assert!(training_data.sample_weights.is_some());

        let (train, test) = training_data.train_test_split(0.5);
        assert_eq!(train.len(), 1);
        assert_eq!(test.len(), 1);
    }

    #[test]
    fn test_time_series_predictor() {
        let config = TimeSeriesConfig::default();
        let predictor = TimeSeriesPredictor::new(&config);

        assert_eq!(predictor.arima_params.ar_coeffs.len(), config.ar_order);
        assert_eq!(predictor.arima_params.ma_coeffs.len(), config.ma_order);
        assert_eq!(predictor.nar_state.order, config.nar_order);
    }

    #[test]
    fn test_enhanced_metrics_tracking() {
        let config = QuantumReservoirConfig::default();
        let qrc = QuantumReservoirComputerEnhanced::new(config).expect("Failed to create QRC");

        let metrics = qrc.get_metrics();
        assert_eq!(metrics.training_examples, 0);
        assert_eq!(metrics.prediction_accuracy, 0.0);
        assert_eq!(metrics.memory_capacity, 0.0);
        assert_eq!(metrics.nonlinear_memory_capacity, 0.0);
        assert_eq!(metrics.quantum_advantage, 0.0);
    }

    #[test]
    fn test_enhanced_feature_sizes() {
        let measurements = vec![
            (OutputMeasurement::PauliExpectation, 24), // 8 qubits * 3 Pauli
            (OutputMeasurement::QuantumFisherInformation, 8), // 8 qubits
            (OutputMeasurement::Variance, 24),         // 8 qubits * 3 Pauli
            (OutputMeasurement::Purity, 1),            // Single value
        ];

        for (measurement, expected_size) in measurements {
            let config = QuantumReservoirConfig {
                num_qubits: 8,
                output_measurement: measurement,
                ..Default::default()
            };

            let feature_size = QuantumReservoirComputerEnhanced::calculate_feature_size(&config);
            assert_eq!(
                feature_size, expected_size,
                "Feature size mismatch for {:?}: expected {}, got {}",
                measurement, expected_size, feature_size
            );
        }
    }
}