qcrypto 0.0.3

Library for the design, simulation and validation of Quantum Cryptography protocols
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
use crate::core::errors::MeasurementError;
use crate::core::utils;
use ndarray::{Array1, Array2, array};
use num_complex::Complex64;

/// Represents a general quantum measurement.
///
/// A measurement is defined by a set of operators $\{M_k\}$ such that $\sum M_k^\dagger M_k = I$.
/// It also associates a real value with each measurement outcome.
#[derive(Clone, Debug)]
pub struct Measurement {
    /// List of measurement operators (Kraus operators).
    pub operators: Vec<Array2<Complex64>>,
    /// Associated measurement values for each outcome.
    pub values: Vec<f64>,
    /// Number of qubits the measurement acts on.
    pub num_qubits: usize,
}

impl Measurement {
    /// Creates a new `Measurement` from a set of operators and values.
    ///
    /// # Arguments
    ///
    /// * `operators` - A vector of `Array2<Complex64>` representing the measurement operators.
    /// * `values` - A vector of `f64` values corresponding to the output of each operator.
    ///
    /// # Returns
    ///
    /// A `Result` containing the constructed `Measurement`.
    ///
    /// # Errors
    ///
    /// Returns `MeasurementError` if:
    /// - The number of operators and values do not match.
    /// - The operators are not of correct dimensions.
    /// - The operators do not satisfy the completeness relation ($\sum M_k^\dagger M_k = I$).
    ///
    /// # Example
    /// ```rust
    /// use qcrypto::Measurement;
    /// use ndarray::Array2;
    /// use num_complex::Complex64;
    ///
    /// // Identity as a single trivial measurement
    /// let eye: Array2<Complex64> = Array2::eye(2);
    /// let m = Measurement::new(vec![eye], vec![0.0]).unwrap();
    /// assert_eq!(m.num_qubits, 1);
    /// ```
    pub fn new(
        operators: Vec<Array2<Complex64>>,
        values: Vec<f64>,
    ) -> Result<Self, MeasurementError> {
        if operators.len() != values.len() {
            return Err(MeasurementError::CountMismatch {
                ops: operators.len(),
                vals: values.len(),
            });
        }

        if operators.is_empty() {
            return Err(MeasurementError::InvalidDimensions);
        }

        let (rows, cols) = operators[0].dim();
        if rows != cols || !rows.is_power_of_two() {
            return Err(MeasurementError::InvalidDimensions);
        }
        // log_2 as rows is power of two
        let num_qubits = rows.trailing_zeros() as usize;

        for op in &operators {
            if op.dim() != (rows, cols) {
                return Err(MeasurementError::InvalidDimensions);
            }
        }

        if !utils::check_kraus_completeness(&operators, rows) {
            return Err(MeasurementError::NotComplete);
        }

        Ok(Self {
            operators,
            values,
            num_qubits,
        })
    }

    /// Creates a valid Measurement from a given POVM (Positive Operator-Valued Measure).
    ///
    /// # Arguments
    ///
    /// * `povm_elements` - A vector of POVM elements $\{E_k\}$ where each $E_k$ is positive semi-definite and $\sum E_k = I$.
    /// * `values` - A vector of values associated with each POVM element.
    ///
    /// # Returns
    ///
    /// A `Result` containing the constructed `Measurement`.
    ///
    /// # Errors
    ///
    /// Returns `MeasurementError` if:
    /// - The elements dimensions are invalid or mismatched.
    /// - The elements do not sum to Identity.
    ///
    /// # Example
    /// ```rust
    /// use qcrypto::Measurement;
    /// use ndarray::Array2;
    /// use num_complex::Complex64;
    ///
    /// // Z-basis POVM: |0><0| and |1><1|
    /// let p0 = Array2::from_diag(&ndarray::array![Complex64::new(1.0, 0.0), Complex64::new(0.0, 0.0)]);
    /// let p1 = Array2::from_diag(&ndarray::array![Complex64::new(0.0, 0.0), Complex64::new(1.0, 0.0)]);
    /// let m = Measurement::from_povm(vec![p0, p1], vec![0.0, 1.0]).unwrap();
    /// assert_eq!(m.num_qubits, 1);
    /// ```
    pub fn from_povm(
        povm_elements: Vec<Array2<Complex64>>,
        values: Vec<f64>,
    ) -> Result<Self, MeasurementError> {
        if povm_elements.len() != values.len() {
            return Err(MeasurementError::CountMismatch {
                ops: povm_elements.len(),
                vals: values.len(),
            });
        }

        if povm_elements.is_empty() {
            return Err(MeasurementError::InvalidDimensions);
        }

        let (rows, cols) = povm_elements[0].dim();

        if rows != cols || !rows.is_power_of_two() {
            return Err(MeasurementError::InvalidDimensions);
        }

        // log_2
        let num_qubits = rows.trailing_zeros() as usize;

        if !utils::check_povm_completeness(&povm_elements, rows) {
            return Err(MeasurementError::NotComplete);
        }

        let kraus_ops = povm_elements
            .iter()
            .map(utils::sqrt_positive_matrix)
            .collect();

        Ok(Measurement {
            operators: kraus_ops,
            values,
            num_qubits,
        })
    }

    /// Expands the measurement operators to act on a larger system.
    ///
    /// # Arguments
    ///
    /// * `num_total_qubits` - The size of the full system.
    /// * `targets` - The indices of the qubits this measurement applies to.
    ///
    /// # Returns
    ///
    /// A `Result` containing the expanded operators.
    ///
    /// # Errors
    ///
    /// Returns `MeasurementError` if the number of targets does not match `num_qubits`.
    ///
    /// # Example
    /// ```rust
    /// use qcrypto::Measurement;
    ///
    /// let m = Measurement::z_basis();
    /// let expanded = m.get_expanded_operators(2, &[0]).unwrap();
    /// assert_eq!(expanded[0].dim(), (4, 4));
    /// ```
    pub fn get_expanded_operators(
        &self,
        num_total_qubits: usize,
        targets: &[usize],
    ) -> Result<Vec<Array2<Complex64>>, MeasurementError> {
        if targets.len() != self.num_qubits {
            return Err(MeasurementError::InvalidDimensions); // Or create a TargetMismatch error
        }

        let mut expanded_ops = Vec::with_capacity(self.operators.len());

        for op in &self.operators {
            let full_op = utils::expand_operator(op, num_total_qubits, targets, &[]);
            expanded_ops.push(full_op);
        }

        Ok(expanded_ops)
    }

    /// Creates a measurement in the Z basis (Computational basis) -> {|0>, |1>}.
    ///
    /// # Returns
    ///
    /// A single-qubit Z-basis measurement.
    ///
    /// # Example
    /// ```rust
    /// use qcrypto::{QuantumState, Measurement};
    ///
    /// let state = QuantumState::new(1); // |0>
    /// let probs = state.set_measurement(&Measurement::z_basis(), &[0]).unwrap();
    /// assert_eq!(probs, vec![1.0, 0.0]);
    /// ```
    pub fn z_basis() -> Measurement {
        let v0: Array1<Complex64> = array![Complex64::new(1.0, 0.0), Complex64::new(0.0, 0.0)];
        let v1: Array1<Complex64> = array![Complex64::new(0.0, 0.0), Complex64::new(1.0, 0.0)];

        let p0 = utils::outer_product(&v0, &v0);
        let p1 = utils::outer_product(&v1, &v1);

        Measurement::new(vec![p0, p1], vec![0.0, 1.0]).expect("Error in basis Z")
    }

    /// Creates a measurement in the X basis (Hadamard basis) -> {|+>, |->}.
    ///
    /// # Returns
    ///
    /// A single-qubit X-basis measurement.
    ///
    /// # Example
    /// ```rust
    /// use qcrypto::{QuantumState, Gate, Measurement};
    ///
    /// let mut state = QuantumState::new(1);
    /// state.apply(&Gate::h(), &[0]).unwrap(); // |+>
    /// let probs = state.set_measurement(&Measurement::x_basis(), &[0]).unwrap();
    /// assert!((probs[0] - 1.0).abs() < 1e-12);
    /// ```
    pub fn x_basis() -> Measurement {
        let inv_sqrt2 = Complex64::new(1.0 / 2.0_f64.sqrt(), 0.0);

        let v_plus: Array1<Complex64> = array![inv_sqrt2, inv_sqrt2];
        let v_minus: Array1<Complex64> = array![inv_sqrt2, -inv_sqrt2];

        let p_plus = utils::outer_product(&v_plus, &v_plus);
        let p_minus = utils::outer_product(&v_minus, &v_minus);

        Measurement::new(vec![p_plus, p_minus], vec![0.0, 1.0]).expect("Error in basis X")
    }

    /// Creates a measurement in the Y basis -> {|+i>, |-i>}.
    ///
    /// # Returns
    ///
    /// A single-qubit Y-basis measurement.
    ///
    /// # Example
    /// ```rust
    /// use qcrypto::Measurement;
    ///
    /// let m = Measurement::y_basis();
    /// assert_eq!(m.num_qubits, 1);
    /// assert_eq!(m.operators.len(), 2);
    /// ```
    pub fn y_basis() -> Measurement {
        let inv_sqrt2 = Complex64::new(1.0 / 2.0_f64.sqrt(), 0.0);
        let i_inv_sqrt2 = Complex64::new(0.0, 1.0 / 2.0_f64.sqrt());

        let v_plus_i: Array1<Complex64> = array![inv_sqrt2, i_inv_sqrt2];
        let v_minus_i: Array1<Complex64> = array![inv_sqrt2, -i_inv_sqrt2];

        let p_plus_i = utils::outer_product(&v_plus_i, &v_plus_i);
        let p_minus_i = utils::outer_product(&v_minus_i, &v_minus_i);

        Measurement::new(vec![p_plus_i, p_minus_i], vec![0.0, 1.0]).expect("Error in basis Y")
    }

    /// Creates a joint 2-qubit measurement in the mathematically inseparable Bell Basis.
    ///
    /// Outcomes map directly to the 4 maximally entangled Bell states:
    /// - 0: $\Phi^+$ (Phi Plus)
    /// - 1: $\Psi^+$ (Psi Plus)
    /// - 2: $\Phi^-$ (Phi Minus)
    /// - 3: $\Psi^-$ (Psi Minus)
    ///
    /// # Returns
    ///
    /// A two-qubit Bell-basis measurement.
    ///
    /// # Example
    /// ```rust
    /// use qcrypto::Measurement;
    ///
    /// let m = Measurement::bell_basis();
    /// assert_eq!(m.num_qubits, 2);
    /// assert_eq!(m.operators.len(), 4);
    /// ```
    pub fn bell_basis() -> Measurement {
        let inv_sqrt2 = Complex64::new(1.0 / 2.0_f64.sqrt(), 0.0);
        let zero = Complex64::new(0.0, 0.0);

        // |Phi+> = (|00> + |11>) / sqrt(2)
        let v_phi_plus: Array1<Complex64> = array![inv_sqrt2, zero, zero, inv_sqrt2];
        // |Psi+> = (|01> + |10>) / sqrt(2)
        let v_psi_plus: Array1<Complex64> = array![zero, inv_sqrt2, inv_sqrt2, zero];
        // |Phi-> = (|00> - |11>) / sqrt(2)
        let v_phi_minus: Array1<Complex64> = array![inv_sqrt2, zero, zero, -inv_sqrt2];
        // |Psi-> = (|01> - |10>) / sqrt(2)
        let v_psi_minus: Array1<Complex64> = array![zero, inv_sqrt2, -inv_sqrt2, zero];

        let p_phi_plus = utils::outer_product(&v_phi_plus, &v_phi_plus);
        let p_psi_plus = utils::outer_product(&v_psi_plus, &v_psi_plus);
        let p_phi_minus = utils::outer_product(&v_phi_minus, &v_phi_minus);
        let p_psi_minus = utils::outer_product(&v_psi_minus, &v_psi_minus);

        Measurement::new(
            vec![p_phi_plus, p_psi_plus, p_phi_minus, p_psi_minus],
            vec![0.0, 1.0, 2.0, 3.0],
        )
        .expect("Error in Bell basis")
    }
}

/// The result of a quantum measurement.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct MeasurementResult {
    /// The index of the outcome (and operator) that occurred.
    pub index: usize,
    /// The value associated with the outcome.
    pub value: f64,
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{Gate, QuantumState};
    use ndarray::Array2;

    // --- Measurement::new boundary tests ---

    #[test]
    fn test_new_count_mismatch() {
        let eye: Array2<Complex64> = Array2::eye(2);
        let result = Measurement::new(vec![eye], vec![0.0, 1.0]);
        assert!(matches!(
            result,
            Err(MeasurementError::CountMismatch { .. })
        ));
    }

    #[test]
    fn test_new_empty_operators() {
        let result = Measurement::new(vec![], vec![]);
        assert!(matches!(result, Err(MeasurementError::InvalidDimensions)));
    }

    #[test]
    fn test_new_non_square_operator() {
        let matrix = Array2::from_shape_vec((2, 3), vec![Complex64::new(1.0, 0.0); 6]).unwrap();
        let result = Measurement::new(vec![matrix], vec![0.0]);
        assert!(matches!(result, Err(MeasurementError::InvalidDimensions)));
    }

    #[test]
    fn test_new_non_power_of_two() {
        let matrix: Array2<Complex64> = Array2::eye(3);
        let result = Measurement::new(vec![matrix], vec![0.0]);
        assert!(matches!(result, Err(MeasurementError::InvalidDimensions)));
    }

    #[test]
    fn test_new_not_complete() {
        let p0 = Array2::from_diag(&array![Complex64::new(1.0, 0.0), Complex64::new(0.0, 0.0)]);
        let result = Measurement::new(vec![p0], vec![0.0]);
        assert!(matches!(result, Err(MeasurementError::NotComplete)));
    }

    #[test]
    fn test_new_mismatched_operator_sizes() {
        let k0: Array2<Complex64> = Array2::eye(2);
        let k1: Array2<Complex64> = Array2::eye(4);
        let result = Measurement::new(vec![k0, k1], vec![0.0, 1.0]);
        assert!(matches!(result, Err(MeasurementError::InvalidDimensions)));
    }

    // --- from_povm boundary tests ---

    #[test]
    fn test_from_povm_count_mismatch() {
        let eye: Array2<Complex64> = Array2::eye(2);
        let result = Measurement::from_povm(vec![eye], vec![0.0, 1.0]);
        assert!(matches!(
            result,
            Err(MeasurementError::CountMismatch { .. })
        ));
    }

    #[test]
    fn test_from_povm_empty() {
        let result = Measurement::from_povm(vec![], vec![]);
        assert!(matches!(result, Err(MeasurementError::InvalidDimensions)));
    }

    #[test]
    fn test_from_povm_non_square() {
        let matrix = Array2::from_shape_vec((2, 3), vec![Complex64::new(1.0, 0.0); 6]).unwrap();
        let result = Measurement::from_povm(vec![matrix], vec![0.0]);
        assert!(matches!(result, Err(MeasurementError::InvalidDimensions)));
    }

    #[test]
    fn test_from_povm_non_power_of_two() {
        let matrix: Array2<Complex64> = Array2::eye(3);
        let result = Measurement::from_povm(vec![matrix], vec![0.0]);
        assert!(matches!(result, Err(MeasurementError::InvalidDimensions)));
    }

    #[test]
    fn test_from_povm_not_complete() {
        let p0 = Array2::from_diag(&array![Complex64::new(1.0, 0.0), Complex64::new(0.0, 0.0)]);
        let result = Measurement::from_povm(vec![p0], vec![0.0]);
        assert!(matches!(result, Err(MeasurementError::NotComplete)));
    }

    #[test]
    fn test_from_povm_success() {
        let p0 = Array2::from_diag(&array![Complex64::new(1.0, 0.0), Complex64::new(0.0, 0.0)]);
        let p1 = Array2::from_diag(&array![Complex64::new(0.0, 0.0), Complex64::new(1.0, 0.0)]);
        let m = Measurement::from_povm(vec![p0, p1], vec![0.0, 1.0]).unwrap();
        assert_eq!(m.num_qubits, 1);
        assert_eq!(m.operators.len(), 2);
    }

    // --- get_expanded_operators boundary test ---

    #[test]
    fn test_expanded_operators_target_mismatch() {
        let m = Measurement::z_basis();
        let result = m.get_expanded_operators(2, &[0, 1]);
        assert!(matches!(result, Err(MeasurementError::InvalidDimensions)));
    }

    #[test]
    fn test_expanded_operators_success() {
        let m = Measurement::z_basis();
        let expanded = m.get_expanded_operators(2, &[0]).unwrap();
        assert_eq!(expanded.len(), 2);
        assert_eq!(expanded[0].dim(), (4, 4));
        assert_eq!(expanded[1].dim(), (4, 4));
    }

    // --- Standard bases: construction + completeness ---

    fn assert_complete(m: &Measurement) {
        let dim = m.operators[0].dim().0;
        let eye = Array2::<Complex64>::eye(dim);
        let mut sum = Array2::<Complex64>::zeros((dim, dim));
        for op in &m.operators {
            let dag = op.t().mapv(|x| x.conj());
            sum = sum + dag.dot(op);
        }
        for (a, b) in sum.iter().zip(eye.iter()) {
            assert!((*a - *b).norm() < 1e-10);
        }
    }

    #[test]
    fn test_z_basis_properties() {
        let m = Measurement::z_basis();
        assert_eq!(m.num_qubits, 1);
        assert_eq!(m.operators.len(), 2);
        assert_complete(&m);
    }

    #[test]
    fn test_x_basis_properties() {
        let m = Measurement::x_basis();
        assert_eq!(m.num_qubits, 1);
        assert_eq!(m.operators.len(), 2);
        assert_complete(&m);
    }

    #[test]
    fn test_y_basis_properties() {
        let m = Measurement::y_basis();
        assert_eq!(m.num_qubits, 1);
        assert_eq!(m.operators.len(), 2);
        assert_complete(&m);
    }

    #[test]
    fn test_bell_basis_properties() {
        let m = Measurement::bell_basis();
        assert_eq!(m.num_qubits, 2);
        assert_eq!(m.operators.len(), 4);
        assert_complete(&m);
    }

    // --- Orthogonality ---

    #[test]
    fn test_z_basis_operators_are_orthogonal() {
        let m = Measurement::z_basis();
        let product = m.operators[0].dot(&m.operators[1]);
        for &val in product.iter() {
            assert!(val.norm() < 1e-12);
        }
    }

    #[test]
    fn test_bell_basis_operators_are_orthogonal() {
        let m = Measurement::bell_basis();
        for i in 0..4 {
            for j in (i + 1)..4 {
                let product = m.operators[i].dot(&m.operators[j]);
                for &val in product.iter() {
                    assert!(
                        val.norm() < 1e-12,
                        "Bell operators {} and {} not orthogonal",
                        i,
                        j
                    );
                }
            }
        }
    }

    // --- Deterministic measurements: eigenstate in its own basis ---

    #[test]
    fn test_z_basis_deterministic_on_eigenstates() {
        // |0> measured in Z → outcome 0 with probability 1
        let mut state = QuantumState::new(1);
        let probs = state
            .set_measurement(&Measurement::z_basis(), &[0])
            .unwrap();
        assert!((probs[0] - 1.0).abs() < 1e-12);
        assert!(probs[1].abs() < 1e-12);

        // |1> measured in Z → outcome 1 with probability 1
        state.apply(&Gate::x(), &[0]).unwrap();
        let probs = state
            .set_measurement(&Measurement::z_basis(), &[0])
            .unwrap();
        assert!(probs[0].abs() < 1e-12);
        assert!((probs[1] - 1.0).abs() < 1e-12);
    }

    #[test]
    fn test_x_basis_deterministic_on_eigenstates() {
        // |+> measured in X → outcome 0 with probability 1
        let mut state = QuantumState::new(1);
        state.apply(&Gate::h(), &[0]).unwrap(); // |+>
        let probs = state
            .set_measurement(&Measurement::x_basis(), &[0])
            .unwrap();
        assert!((probs[0] - 1.0).abs() < 1e-12);
        assert!(probs[1].abs() < 1e-12);

        // |-> measured in X → outcome 1 with probability 1
        let mut state2 = QuantumState::new(1);
        state2.apply(&Gate::x(), &[0]).unwrap();
        state2.apply(&Gate::h(), &[0]).unwrap(); // X then H = |->
        let probs = state2
            .set_measurement(&Measurement::x_basis(), &[0])
            .unwrap();
        assert!(probs[0].abs() < 1e-12);
        assert!((probs[1] - 1.0).abs() < 1e-12);
    }

    #[test]
    fn test_y_basis_deterministic_on_eigenstates() {
        // |+i> = S·H|0> measured in Y → outcome 0 with probability 1
        let mut state = QuantumState::new(1);
        state
            .apply(&Gate::h(), &[0])
            .unwrap()
            .apply(&Gate::s(), &[0])
            .unwrap(); // |+i>
        let probs = state
            .set_measurement(&Measurement::y_basis(), &[0])
            .unwrap();
        assert!((probs[0] - 1.0).abs() < 1e-12);
        assert!(probs[1].abs() < 1e-12);
    }

    #[test]
    fn test_bell_basis_deterministic_on_phi_plus() {
        // |\Phi+> = (|00> + |11>) / \sqrt{2} measured in Bell basis → outcome 0
        let mut state = QuantumState::new(2);
        state
            .apply(&Gate::h(), &[0])
            .unwrap()
            .apply_controlled(&Gate::x(), &[1], &[0])
            .unwrap();

        let probs = state
            .set_measurement(&Measurement::bell_basis(), &[0, 1])
            .unwrap();
        assert!((probs[0] - 1.0).abs() < 1e-12); // \Phi+
        assert!(probs[1].abs() < 1e-12);
        assert!(probs[2].abs() < 1e-12);
        assert!(probs[3].abs() < 1e-12);
    }
}