quant-iron 2.0.0

A high-performance, hardware-accelerated modular quantum computing library with a focus on physical applications. Quant-Iron provides tools to represent quantum states, apply standard quantum gates, perform measurements, build quantum circuits, and implement quantum algorithms.
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

use crate::components::state::State;
use num_complex::Complex;
use std::ops::Deref;
use crate::compiler::{compilable::Compilable, ir::InstructionIR};

#[derive(Debug, Clone, PartialEq)]
/// Represents the result of a measurement on a quantum state.
///
/// # Fields
///
/// * `basis` - The basis of measurement (e.g., computational basis).
/// * `indices` - The indices of the measured qubits.
/// * `outcomes` - The measurement outcomes for the qubits.
/// * `new_state` - The new state vector after the measurement.
pub struct MeasurementResult {
    /// The basis of measurement
    pub basis: MeasurementBasis,
    /// The indices of the measured qubits.
    pub indices: Vec<usize>,
    /// The measurement outcomes for the qubits.
    /// Represented as a vector of bits (0 or 1).
    pub outcomes: Vec<u8>,
    /// The new state vector after the measurement.
    pub new_state: State,
}

// Allow dereferencing to the new state vector for method chaining.
impl Deref for MeasurementResult {
    type Target = State;

    fn deref(&self) -> &Self::Target {
        &self.new_state
    }
}

impl MeasurementResult {
    /// Gets the measured indices of the qubits.
    ///
    /// # Returns
    ///
    /// * `indices` - A vector of indices of the measured qubits.
    pub fn get_indices(&self) -> &Vec<usize> {
        &self.indices
    }

    /// Gets the basis of measurement.
    ///
    /// # Returns
    ///
    /// * `basis` - The basis of measurement.
    pub fn get_basis(&self) -> &MeasurementBasis {
        &self.basis
    }

    /// Gets the measurement outcomes for the qubits.
    ///
    /// # Returns
    ///
    /// * `outcomes` - A vector of measurement outcomes for the qubits.
    pub fn get_outcomes(&self) -> &Vec<u8> {
        &self.outcomes
    }

    /// Gets the new state vector after the measurement.
    ///
    /// # Returns
    ///
    /// * `new_state` - The new state vector after the measurement.
    pub fn get_new_state(&self) -> &State {
        &self.new_state
    }
}

/// Represents the basis of measurement for qubits.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum MeasurementBasis {
    /// The computational basis |0> and |1>.
    /// Also known as the standard basis or Z basis.
    Computational,
    /// The X basis (|+> and |->).
    X,
    /// The Y basis (|i+> and |i->).
    Y,
    /// A custom measurement basis defined by a 2x2 unitary matrix.
    Custom([[Complex<f64>; 2]; 2]),
}

#[derive(Debug, Clone, Copy, PartialEq)]
/// Represents a measurement operation on a quantum circuit.
/// 
/// This is an internal struct strictly used for the IR representation of a measurement operation.
pub(crate) struct MeasurementOperation {
    /// The basis of measurement.
    pub basis: MeasurementBasis,
}

impl Compilable for MeasurementOperation {
    fn to_ir(&self, targets: Vec<usize>, _controls: Vec<usize>) -> Vec<InstructionIR> {
        // No controls for measurement operations.
        vec![InstructionIR::Measurement(targets, self.basis)]
    }
}