roqoqo 1.22.2

Rust Quantum Computing Toolkit by HQS
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243

// Copyright © 2021-2024 HQS Quantum Simulations GmbH. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
// in compliance with the License. You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software distributed under the
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
// express or implied. See the License for the specific language governing permissions and
// limitations under the License.

use crate::operations::*;
use crate::Circuit;
use ndarray::Array2;
use num_complex::Complex64;

/// The triple-controlled PauliX gate.
///
#[allow(clippy::upper_case_acronyms)]
#[derive(
    Debug,
    Clone,
    PartialEq,
    roqoqo_derive::Operate,
    roqoqo_derive::OperateFourQubit,
    roqoqo_derive::InvolveQubits,
    roqoqo_derive::Substitute,
)]
#[cfg_attr(feature = "serialize", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "json_schema", derive(schemars::JsonSchema))]
pub struct TripleControlledPauliX {
    /// The first control qubit involved in the triple-controlled PauliX gate.
    control_0: usize,
    /// The second control qubit involved in the triple-controlled PauliX gate.
    control_1: usize,
    /// The third control qubit involved in the triple-controlled PauliX gate.
    control_2: usize,
    /// The target qubit to apply the PauliX gate to.
    target: usize,
}

impl super::ImplementedIn1point16 for TripleControlledPauliX {}

impl SupportedVersion for TripleControlledPauliX {
    fn minimum_supported_roqoqo_version(&self) -> (u32, u32, u32) {
        (1, 16, 0)
    }
}

#[allow(non_upper_case_globals)]
const TAGS_TripleControlledPauliX: &[&str; 4] = &[
    "Operation",
    "GateOperation",
    "FourQubitGateOperation",
    "TripleControlledPauliX",
];

impl OperateGate for TripleControlledPauliX {
    fn unitary_matrix(&self) -> Result<Array2<Complex64>, RoqoqoError> {
        let dim = 16;
        let mut array: Array2<Complex64> = Array2::zeros((dim, dim));
        for i in 0..dim - 2 {
            array[(i, i)] = Complex64::new(1.0, 0.0);
        }
        array[(dim - 2, dim - 1)] = Complex64::new(1.0, 0.0);
        array[(dim - 1, dim - 2)] = Complex64::new(1.0, 0.0);
        Ok(array)
    }
}

impl OperateFourQubitGate for TripleControlledPauliX {
    fn circuit(&self) -> Circuit {
        let mut circuit = Circuit::new();
        circuit += CNOT::new(self.control_0, self.target);
        circuit += CNOT::new(self.control_0, self.control_1);
        circuit += CNOT::new(self.control_1, self.target);
        circuit += CNOT::new(self.control_0, self.control_1);
        circuit += CNOT::new(self.control_1, self.target);
        circuit += CNOT::new(self.control_1, self.control_2);
        circuit += CNOT::new(self.control_2, self.target);
        circuit += CNOT::new(self.control_0, self.control_2);
        circuit += CNOT::new(self.control_2, self.target);
        circuit += CNOT::new(self.control_1, self.control_2);
        circuit += CNOT::new(self.control_2, self.target);
        circuit += CNOT::new(self.control_0, self.control_2);
        circuit += CNOT::new(self.control_2, self.target);
        circuit
    }
}

/// The triple-controlled PauliZ gate.
///
#[allow(clippy::upper_case_acronyms)]
#[derive(
    Debug,
    Clone,
    PartialEq,
    roqoqo_derive::Operate,
    roqoqo_derive::OperateFourQubit,
    roqoqo_derive::InvolveQubits,
    roqoqo_derive::Substitute,
)]
#[cfg_attr(feature = "serialize", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "json_schema", derive(schemars::JsonSchema))]
pub struct TripleControlledPauliZ {
    /// The first control qubit involved in the triple-controlled PauliZ gate.
    control_0: usize,
    /// The second control qubit involved in the triple-controlled PauliZ gate.
    control_1: usize,
    /// The third control qubit involved in the triple-controlled PauliZ gate.
    control_2: usize,
    /// The target qubit to apply the PauliZ gate to.
    target: usize,
}

impl super::ImplementedIn1point16 for TripleControlledPauliZ {}

impl SupportedVersion for TripleControlledPauliZ {
    fn minimum_supported_roqoqo_version(&self) -> (u32, u32, u32) {
        (1, 16, 0)
    }
}

#[allow(non_upper_case_globals)]
const TAGS_TripleControlledPauliZ: &[&str; 4] = &[
    "Operation",
    "GateOperation",
    "FourQubitGateOperation",
    "TripleControlledPauliZ",
];

impl OperateGate for TripleControlledPauliZ {
    fn unitary_matrix(&self) -> Result<Array2<Complex64>, RoqoqoError> {
        let dim = 16;
        let mut array: Array2<Complex64> = Array2::zeros((dim, dim));
        for i in 0..dim - 1 {
            array[(i, i)] = Complex64::new(1.0, 0.0);
        }
        array[(dim - 1, dim - 1)] = Complex64::new(-1.0, 0.0);
        Ok(array)
    }
}

impl OperateFourQubitGate for TripleControlledPauliZ {
    fn circuit(&self) -> Circuit {
        let mut circuit = Circuit::new();
        circuit += ControlledPauliZ::new(self.control_0, self.target);
        circuit += CNOT::new(self.control_0, self.control_1);
        circuit += ControlledPauliZ::new(self.control_1, self.target);
        circuit += CNOT::new(self.control_0, self.control_1);
        circuit += ControlledPauliZ::new(self.control_1, self.target);
        circuit += CNOT::new(self.control_1, self.control_2);
        circuit += ControlledPauliZ::new(self.control_2, self.target);
        circuit += CNOT::new(self.control_0, self.control_2);
        circuit += ControlledPauliZ::new(self.control_2, self.target);
        circuit += CNOT::new(self.control_1, self.control_2);
        circuit += ControlledPauliZ::new(self.control_2, self.target);
        circuit += CNOT::new(self.control_0, self.control_2);
        circuit += ControlledPauliZ::new(self.control_2, self.target);
        circuit
    }
}

/// The triple-controlled PhaseShift gate.
///
#[allow(clippy::upper_case_acronyms)]
#[derive(
    Debug,
    Clone,
    PartialEq,
    roqoqo_derive::Operate,
    roqoqo_derive::OperateFourQubit,
    roqoqo_derive::InvolveQubits,
    roqoqo_derive::Substitute,
)]
#[cfg_attr(feature = "serialize", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "json_schema", derive(schemars::JsonSchema))]
pub struct TripleControlledPhaseShift {
    /// The first control qubit involved in the triple-controlled PhaseShift gate.
    control_0: usize,
    /// The second control qubit involved in the triple-controlled PhaseShift gate.
    control_1: usize,
    /// The third control qubit involved in the triple-controlled PhaseShift gate.
    control_2: usize,
    /// The target qubit to apply the PhaseShift gate to.
    target: usize,
    /// The rotation angle θ.
    theta: CalculatorFloat,
}

impl super::ImplementedIn1point16 for TripleControlledPhaseShift {}

impl SupportedVersion for TripleControlledPhaseShift {
    fn minimum_supported_roqoqo_version(&self) -> (u32, u32, u32) {
        (1, 16, 0)
    }
}

#[allow(non_upper_case_globals)]
const TAGS_TripleControlledPhaseShift: &[&str; 4] = &[
    "Operation",
    "GateOperation",
    "FourQubitGateOperation",
    "TripleControlledPhaseShift",
];

impl OperateGate for TripleControlledPhaseShift {
    fn unitary_matrix(&self) -> Result<Array2<Complex64>, RoqoqoError> {
        let c: f64 = (f64::try_from(self.theta.clone())?).cos();
        let s: f64 = (f64::try_from(self.theta.clone())?).sin();
        let dim = 16;
        let mut array: Array2<Complex64> = Array2::zeros((dim, dim));
        for i in 0..dim - 1 {
            array[(i, i)] = Complex64::new(1.0, 0.0);
        }
        array[(dim - 1, dim - 1)] = Complex64::new(c, s);
        Ok(array)
    }
}

impl OperateFourQubitGate for TripleControlledPhaseShift {
    fn circuit(&self) -> Circuit {
        let mut circuit = Circuit::new();
        circuit += ControlledPhaseShift::new(self.control_0, self.target, self.theta().clone() / 2);
        circuit += CNOT::new(self.control_0, self.control_1);
        circuit +=
            ControlledPhaseShift::new(self.control_1, self.target, -self.theta().clone() / 2);
        circuit += CNOT::new(self.control_0, self.control_1);
        circuit += ControlledPhaseShift::new(self.control_1, self.target, self.theta().clone() / 2);
        circuit += CNOT::new(self.control_1, self.control_2);
        circuit +=
            ControlledPhaseShift::new(self.control_2, self.target, -self.theta().clone() / 2);
        circuit += CNOT::new(self.control_0, self.control_2);
        circuit += ControlledPhaseShift::new(self.control_2, self.target, self.theta().clone() / 2);
        circuit += CNOT::new(self.control_1, self.control_2);
        circuit +=
            ControlledPhaseShift::new(self.control_2, self.target, -self.theta().clone() / 2);
        circuit += CNOT::new(self.control_0, self.control_2);
        circuit += ControlledPhaseShift::new(self.control_2, self.target, self.theta().clone() / 2);
        circuit
    }
}