quantrs2_ml/torchquantum/gates/single_qubit/
tqsx_traits.rs

1//! # TQSX - Trait Implementations
2//!
3//! This module contains trait implementations for `TQSX`.
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::TQSX;
20
21impl Default for TQSX {
22    fn default() -> Self {
23        Self::new()
24    }
25}
26
27impl TQModule for TQSX {
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        "SX"
51    }
52}
53
54impl TQOperator for TQSX {
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        let half = 0.5;
63        if self.inverse {
64            Array2::from_shape_vec(
65                (2, 2),
66                vec![
67                    CType::new(half, -half),
68                    CType::new(half, half),
69                    CType::new(half, half),
70                    CType::new(half, -half),
71                ],
72            )
73            .unwrap_or_else(|_| Array2::eye(2).mapv(|x| CType::new(x, 0.0)))
74        } else {
75            Array2::from_shape_vec(
76                (2, 2),
77                vec![
78                    CType::new(half, half),
79                    CType::new(half, -half),
80                    CType::new(half, -half),
81                    CType::new(half, half),
82                ],
83            )
84            .unwrap_or_else(|_| Array2::eye(2).mapv(|x| CType::new(x, 0.0)))
85        }
86    }
87    fn apply(&mut self, qdev: &mut TQDevice, wires: &[usize]) -> Result<()> {
88        self.apply_with_params(qdev, wires, None)
89    }
90    fn apply_with_params(
91        &mut self,
92        qdev: &mut TQDevice,
93        wires: &[usize],
94        _params: Option<&[f64]>,
95    ) -> Result<()> {
96        if wires.is_empty() {
97            return Err(MLError::InvalidConfiguration(
98                "SX gate requires exactly 1 wire".to_string(),
99            ));
100        }
101        let matrix = self.get_matrix(None);
102        qdev.apply_single_qubit_gate(wires[0], &matrix)?;
103        if qdev.record_op {
104            qdev.record_operation(OpHistoryEntry {
105                name: "sx".to_string(),
106                wires: wires.to_vec(),
107                params: None,
108                inverse: self.inverse,
109                trainable: false,
110            });
111        }
112        Ok(())
113    }
114    fn has_params(&self) -> bool {
115        false
116    }
117    fn trainable(&self) -> bool {
118        false
119    }
120    fn inverse(&self) -> bool {
121        self.inverse
122    }
123    fn set_inverse(&mut self, inverse: bool) {
124        self.inverse = inverse;
125    }
126}