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

// 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.

/// Enumeration for the Pauli spin operations
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum PauliOp
{
    /// Identity
    I,
    /// Pauli Z
    Z,
    /// Pauli X
    X,
    /// Pauli Y
    Y
}

impl PauliOp
{
    /// Create a new PauliOp from its bit representation
    pub fn from_bits(bits: u64) -> Self
    {
        match bits & 0x03
        {
            0 => PauliOp::I,
            1 => PauliOp::Z,
            2 => PauliOp::X,
            3 => PauliOp::Y,
            _ => unreachable!()
        }
    }

    /// Convert a PauliOp to its bit representation
    pub fn to_bits(self) -> u64
    {
        match self
        {
            PauliOp::I => 0,
            PauliOp::Z => 1,
            PauliOp::X => 2,
            PauliOp::Y => 3
        }
    }
}

impl ::std::fmt::Display for PauliOp
{
    fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result
    {
        match *self
        {
            PauliOp::I => write!(f, "I"),
            PauliOp::Z => write!(f, "Z"),
            PauliOp::X => write!(f, "X"),
            PauliOp::Y => write!(f, "Y"),
        }
    }
}

#[cfg(test)]
mod tests
{
    use super::PauliOp;

    #[test]
    fn test_from_bits()
    {
        assert_eq!(PauliOp::from_bits(0), PauliOp::I);
        assert_eq!(PauliOp::from_bits(1), PauliOp::Z);
        assert_eq!(PauliOp::from_bits(2), PauliOp::X);
        assert_eq!(PauliOp::from_bits(3), PauliOp::Y);
        assert_eq!(PauliOp::from_bits(4), PauliOp::I);
        assert_eq!(PauliOp::from_bits(0xff), PauliOp::Y);
    }

    #[test]
    fn test_to_bits()
    {
        assert_eq!(PauliOp::to_bits(PauliOp::I), 0);
        assert_eq!(PauliOp::to_bits(PauliOp::Z), 1);
        assert_eq!(PauliOp::to_bits(PauliOp::X), 2);
        assert_eq!(PauliOp::to_bits(PauliOp::Y), 3);
    }

    #[test]
    fn test_display()
    {
        assert_eq!(format!("{}", PauliOp::I), "I");
        assert_eq!(format!("{}", PauliOp::Z), "Z");
        assert_eq!(format!("{}", PauliOp::X), "X");
        assert_eq!(format!("{}", PauliOp::Y), "Y");
    }
}