q1tsim 0.5.0

A simple, efficient, quantum computer simulator.
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
244
245

// Copyright 2019 Q1t BV
//
// 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::gates::Gate;
use crate::stabilizer::PauliOp;

/// Controlled `Y` gate.
pub struct CY
{
    cgate: crate::gates::C<crate::gates::Y>
}

impl CY
{
    pub fn new() -> Self
    {
        CY
        {
            cgate: crate::gates::C::new(crate::gates::Y::new())
        }
    }

    pub fn cost() -> f64
    {
        crate::gates::CX::cost() + 2.0*crate::gates::U1::cost()
    }
}

impl crate::gates::Gate for CY
{
    fn cost(&self) -> f64 { Self::cost() }
    fn description(&self) -> &str { self.cgate.description() }
    fn nr_affected_bits(&self) -> usize { self.cgate.nr_affected_bits() }
    fn matrix(&self) -> crate::cmatrix::CMatrix { self.cgate.matrix() }
    fn apply_slice(&self, state: crate::cmatrix::CVecSliceMut)
    {
        self.cgate.apply_slice(state);
    }
    fn apply_mat_slice(&self, state: crate::cmatrix::CMatSliceMut)
    {
        self.cgate.apply_mat_slice(state);
    }
    fn is_stabilizer(&self) -> bool
    {
        true
    }
    fn conjugate(&self, ops: &mut [crate::stabilizer::PauliOp]) -> crate::error::Result<bool>
    {
        self.check_nr_bits(ops.len())?;
        let (phase, op0, op1) = match (ops[0], ops[1])
        {
            (PauliOp::I, PauliOp::I) => (false, PauliOp::I, PauliOp::I),
            (PauliOp::I, PauliOp::Z) => (false, PauliOp::Z, PauliOp::Z),
            (PauliOp::I, PauliOp::X) => (false, PauliOp::Z, PauliOp::X),
            (PauliOp::I, PauliOp::Y) => (false, PauliOp::I, PauliOp::Y),
            (PauliOp::Z, PauliOp::I) => (false, PauliOp::Z, PauliOp::I),
            (PauliOp::Z, PauliOp::Z) => (false, PauliOp::I, PauliOp::Z),
            (PauliOp::Z, PauliOp::X) => (false, PauliOp::I, PauliOp::X),
            (PauliOp::Z, PauliOp::Y) => (false, PauliOp::Z, PauliOp::Y),
            (PauliOp::X, PauliOp::I) => (false, PauliOp::X, PauliOp::Y),
            (PauliOp::X, PauliOp::Z) => (false, PauliOp::Y, PauliOp::X),
            (PauliOp::X, PauliOp::X) => (true,  PauliOp::Y, PauliOp::Z),
            (PauliOp::X, PauliOp::Y) => (false, PauliOp::X, PauliOp::I),
            (PauliOp::Y, PauliOp::I) => (false, PauliOp::Y, PauliOp::Y),
            (PauliOp::Y, PauliOp::Z) => (true,  PauliOp::X, PauliOp::X),
            (PauliOp::Y, PauliOp::X) => (false, PauliOp::X, PauliOp::Z),
            (PauliOp::Y, PauliOp::Y) => (false, PauliOp::Y, PauliOp::I),
        };
        ops[0] = op0;
        ops[1] = op1;
        Ok(phase)
    }
}

impl crate::export::OpenQasm for CY
{
    fn open_qasm(&self, bit_names: &[String], bits: &[usize])
        -> crate::error::Result<String>
    {
        self.check_nr_bits(bits.len())?;
        Ok(format!("cy {}, {}", bit_names[bits[0]], bit_names[bits[1]]))
    }
}

impl crate::export::CQasm for CY
{
    fn c_qasm(&self, bit_names: &[String], bits: &[usize])
        -> crate::error::Result<String>
    {
        self.cgate.check_nr_bits(bits.len())?;
        let b0 = &bit_names[bits[0]];
        let b1 = &bit_names[bits[1]];
        Ok(format!("sdag {}\ncnot {}, {}\ns {}", b1, b0, b1, b1))
    }
}

impl crate::export::Latex for CY
{
    fn latex(&self, bits: &[usize], state: &mut crate::export::LatexExportState)
        -> crate::error::Result<()>
    {
        self.cgate.latex(bits, state)
    }
}

#[cfg(test)]
mod tests
{
    use super::CY;
    use crate::cmatrix;
    use crate::export::{Latex, LatexExportState, OpenQasm, CQasm};
    use crate::gates::{gate_test, Gate};
    use crate::stabilizer::PauliOp;

    #[test]
    fn test_description()
    {
        let gate = CY::new();
        assert_eq!(gate.description(), "CY");
    }

    #[test]
    fn test_matrix()
    {
        let z = cmatrix::COMPLEX_ZERO;
        let o = cmatrix::COMPLEX_ONE;
        let i = cmatrix::COMPLEX_I;

        let gate = CY::new();
        assert_complex_matrix_eq!(gate.matrix(), array![
            [o, z, z,  z],
            [z, o, z,  z],
            [z, z, z, -i],
            [z, z, i,  z]
        ]);
    }

    #[test]
    fn test_apply()
    {
        let z = cmatrix::COMPLEX_ZERO;
        let o = cmatrix::COMPLEX_ONE;
        let i = cmatrix::COMPLEX_I;
        let x = cmatrix::COMPLEX_HSQRT2;
        let h = o * 0.5;

        let mut state = array![
            [o, z,  h,  z],
            [z, z, -h,  z],
            [z, o,  h,  x],
            [z, z, -h, -x]
        ];
        let result = array![
            [o, z,   h,   z],
            [z, z,  -h,   z],
            [z, z, h*i, x*i],
            [z, i, h*i, x*i]
        ];
        gate_test(CY::new(), &mut state, &result);
    }

    #[test]
    fn test_cost()
    {
        assert_eq!(CY::new().cost(), 1015.0);
    }

    #[test]
    fn test_open_qasm()
    {
        let bit_names = [String::from("qb0"), String::from("qb1")];
        let open_qasm = CY::new().open_qasm(&bit_names, &[0, 1]);
        assert_eq!(open_qasm, Ok(String::from("cy qb0, qb1")));
    }

    #[test]
    fn test_c_qasm()
    {
        let bit_names = [String::from("qb0"), String::from("qb1")];
        let c_qasm = CY::new().c_qasm(&bit_names, &[0, 1]);
        assert_eq!(c_qasm, Ok(String::from(
r#"sdag qb1
cnot qb0, qb1
s qb1"#)));
    }

    #[test]
    fn test_latex()
    {
        let gate = CY::new();
        let mut state = LatexExportState::new(2, 0);
        assert_eq!(gate.latex(&[1, 0], &mut state), Ok(()));
        assert_eq!(state.code(),
r#"\Qcircuit @C=1em @R=.7em {
    \lstick{\ket{0}} & \gate{Y} & \qw \\
    \lstick{\ket{0}} & \ctrl{-1} & \qw \\
}
"#);
    }

    #[test]
    fn test_conjugate()
    {
        const OPS_Y: [(PauliOp, PauliOp, PauliOp, PauliOp, bool); 16] = [
            (PauliOp::I, PauliOp::I, PauliOp::I, PauliOp::I, false),
            (PauliOp::I, PauliOp::Z, PauliOp::Z, PauliOp::Z, false),
            (PauliOp::I, PauliOp::X, PauliOp::Z, PauliOp::X, false),
            (PauliOp::I, PauliOp::Y, PauliOp::I, PauliOp::Y, false),
            (PauliOp::Z, PauliOp::I, PauliOp::Z, PauliOp::I, false),
            (PauliOp::Z, PauliOp::Z, PauliOp::I, PauliOp::Z, false),
            (PauliOp::Z, PauliOp::X, PauliOp::I, PauliOp::X, false),
            (PauliOp::Z, PauliOp::Y, PauliOp::Z, PauliOp::Y, false),
            (PauliOp::X, PauliOp::I, PauliOp::X, PauliOp::Y, false),
            (PauliOp::X, PauliOp::Z, PauliOp::Y, PauliOp::X, false),
            (PauliOp::X, PauliOp::X, PauliOp::Y, PauliOp::Z, true ),
            (PauliOp::X, PauliOp::Y, PauliOp::X, PauliOp::I, false),
            (PauliOp::Y, PauliOp::I, PauliOp::Y, PauliOp::Y, false),
            (PauliOp::Y, PauliOp::Z, PauliOp::X, PauliOp::X, true ),
            (PauliOp::Y, PauliOp::X, PauliOp::X, PauliOp::Z, false),
            (PauliOp::Y, PauliOp::Y, PauliOp::Y, PauliOp::I, false)
        ];

        let mut op = [PauliOp::I; 2];
        for &(op0, op1, r0, r1, p) in &OPS_Y
        {
            op[0] = op0;
            op[1] = op1;
            let phase = CY::new().conjugate(&mut op).unwrap();
            assert_eq!(op[0], r0);
            assert_eq!(op[1], r1);
            assert_eq!(phase, p);
        }
    }
}