quantrs2_ml/torchquantum/gates/single_qubit/
tqpaulix_traits.rs

1//! # TQPauliX - Trait Implementations
2//!
3//! This module contains trait implementations for `TQPauliX`.
4//!
5//! ## Implemented Traits
6//!
7//! - `Default`
8//! - `TQModule`
9//! - `TQOperator`
10//!
11//! 🤖 Generated with [SplitRS](https://github.com/cool-japan/splitrs)
12
13use super::super::super::{
14    CType, NParamsEnum, OpHistoryEntry, TQDevice, TQModule, TQOperator, TQParameter, WiresEnum,
15};
16use crate::error::{MLError, Result};
17use scirs2_core::ndarray::{Array1, Array2, ArrayD, IxDyn};
18
19use super::types::TQPauliX;
20
21impl Default for TQPauliX {
22    fn default() -> Self {
23        Self::new()
24    }
25}
26
27impl TQModule for TQPauliX {
28    fn forward(&mut self, _qdev: &mut TQDevice) -> Result<()> {
29        Err(MLError::InvalidConfiguration(
30            "Use apply() instead of forward() for operators".to_string(),
31        ))
32    }
33    fn parameters(&self) -> Vec<TQParameter> {
34        Vec::new()
35    }
36    fn n_wires(&self) -> Option<usize> {
37        Some(1)
38    }
39    fn set_n_wires(&mut self, _n_wires: usize) {}
40    fn is_static_mode(&self) -> bool {
41        self.static_mode
42    }
43    fn static_on(&mut self) {
44        self.static_mode = true;
45    }
46    fn static_off(&mut self) {
47        self.static_mode = false;
48    }
49    fn name(&self) -> &str {
50        "PauliX"
51    }
52}
53
54impl TQOperator for TQPauliX {
55    fn num_wires(&self) -> WiresEnum {
56        WiresEnum::Fixed(1)
57    }
58    fn num_params(&self) -> NParamsEnum {
59        NParamsEnum::Fixed(0)
60    }
61    fn get_matrix(&self, _params: Option<&[f64]>) -> Array2<CType> {
62        Array2::from_shape_vec(
63            (2, 2),
64            vec![
65                CType::new(0.0, 0.0),
66                CType::new(1.0, 0.0),
67                CType::new(1.0, 0.0),
68                CType::new(0.0, 0.0),
69            ],
70        )
71        .unwrap_or_else(|_| Array2::eye(2).mapv(|x| CType::new(x, 0.0)))
72    }
73    fn apply(&mut self, qdev: &mut TQDevice, wires: &[usize]) -> Result<()> {
74        self.apply_with_params(qdev, wires, None)
75    }
76    fn apply_with_params(
77        &mut self,
78        qdev: &mut TQDevice,
79        wires: &[usize],
80        _params: Option<&[f64]>,
81    ) -> Result<()> {
82        if wires.is_empty() {
83            return Err(MLError::InvalidConfiguration(
84                "PauliX gate requires exactly 1 wire".to_string(),
85            ));
86        }
87        let matrix = self.get_matrix(None);
88        qdev.apply_single_qubit_gate(wires[0], &matrix)?;
89        if qdev.record_op {
90            qdev.record_operation(OpHistoryEntry {
91                name: "paulix".to_string(),
92                wires: wires.to_vec(),
93                params: None,
94                inverse: self.inverse,
95                trainable: false,
96            });
97        }
98        Ok(())
99    }
100    fn has_params(&self) -> bool {
101        false
102    }
103    fn trainable(&self) -> bool {
104        false
105    }
106    fn inverse(&self) -> bool {
107        self.inverse
108    }
109    fn set_inverse(&mut self, inverse: bool) {
110        self.inverse = inverse;
111    }
112}