oxicuda-quantum 0.5.5

Quantum simulation primitives for OxiCUDA — state-vector simulation, Pauli expectation values, VQE/QAOA, density matrices, Trotter-Suzuki, quantum kernels
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

use crate::pauli::pauli_string::PauliOp;

/// A Hamiltonian as a sum of weighted Pauli string terms.
#[derive(Debug, Clone, Default)]
pub struct Hamiltonian {
    pub terms: Vec<(f32, Vec<PauliOp>)>,
}

impl Hamiltonian {
    #[must_use]
    pub fn new() -> Self {
        Self { terms: Vec::new() }
    }

    /// Add a term `coeff * ⊗ops` to the Hamiltonian.
    pub fn add_term(&mut self, coeff: f32, ops: Vec<PauliOp>) {
        self.terms.push((coeff, ops));
    }

    /// Number of qubits inferred from the first term.
    #[must_use]
    pub fn n_qubits(&self) -> usize {
        self.terms.first().map(|(_, ops)| ops.len()).unwrap_or(0)
    }
}

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

    #[test]
    fn hamiltonian_n_qubits() {
        let mut h = Hamiltonian::new();
        h.add_term(1.0, vec![PauliOp::Z, PauliOp::I]);
        assert_eq!(h.n_qubits(), 2);
    }
}