quantrs2_ml/torchquantum/gates/single_qubit/
tqs_traits.rs

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