qecp 0.2.7

Quantum Error Correction Playground for Surface Code Research
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280

//! # Noise Model
//!
//! customized error rate with high flexibility
//!

use super::code_builder::*;
#[cfg(feature = "python_binding")]
use super::pyo3::prelude::*;
use super::simulator::*;
use super::types::*;
use super::util_macros::*;
use crate::visualize::*;
use serde::{Deserialize, Serialize};
use std::sync::Arc;

/// describing an noise model, strictly corresponding to an instance of `Simulator`
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "python_binding", pyclass)]
pub struct NoiseModel {
    /// each noise model node corresponds to a simulator node, this allows immutable sharing between threads
    pub nodes: Vec<Vec<Vec<Option<Arc<NoiseModelNode>>>>>,
    /// additional noise that are unknown to the decoder, could be anything
    pub additional_noise: Vec<AdditionalNoise>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "python_binding", pyclass)]
pub struct AdditionalNoise {
    #[serde(rename = "p")]
    pub probability: f64,
    #[serde(rename = "ee")]
    pub erasures: SparseErasures,
    #[serde(rename = "pe")]
    pub pauli_errors: SparseErrorPattern,
}

impl QecpVisualizer for NoiseModel {
    fn component_info(&self, abbrev: bool) -> (String, serde_json::Value) {
        let name = "noise_model";
        let info = json!({
            "nodes": (0..self.nodes.len()).map(|t| {
                (0..self.nodes[t].len()).map(|i| {
                    (0..self.nodes[t][i].len()).map(|j| {
                        let position = &pos!(t, i, j);
                        if self.is_node_exist(position) {
                            let node = self.get_node_unwrap(position);
                            Some(json!({
                                if abbrev { "p" } else { "position" }: position,  // for readability
                                if abbrev { "pp" } else { "pauli_error_rates" }: node.pauli_error_rates,
                                if abbrev { "pe" } else { "erasure_error_rate" }: node.erasure_error_rate,
                                if abbrev { "corr_pp" } else { "correlated_pauli_error_rates" }: node.correlated_pauli_error_rates,
                                if abbrev { "corr_pe" } else { "correlated_erasure_error_rates" }: node.correlated_erasure_error_rates,
                            }))
                        } else {
                            None
                        }
                    }).collect::<Vec<Option<serde_json::Value>>>()
                }).collect::<Vec<Vec<Option<serde_json::Value>>>>()
            }).collect::<Vec<Vec<Vec<Option<serde_json::Value>>>>>(),
            "additional_noise": self.additional_noise,
        });
        (name.to_string(), info)
    }
}

/// noise model node corresponds to
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "python_binding", pyclass)]
pub struct NoiseModelNode {
    /// without losing generality, errors are applied after the gate
    #[serde(rename = "pp")]
    pub pauli_error_rates: PauliErrorRates,
    #[serde(rename = "pe")]
    pub erasure_error_rate: f64,
    #[serde(rename = "corr_pp")]
    pub correlated_pauli_error_rates: Option<CorrelatedPauliErrorRates>,
    #[serde(rename = "corr_pe")]
    pub correlated_erasure_error_rates: Option<CorrelatedErasureErrorRates>,
}

impl Default for NoiseModelNode {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg_attr(feature = "python_binding", cfg_eval)]
#[cfg_attr(feature = "python_binding", pymethods)]
impl NoiseModelNode {
    #[cfg_attr(feature = "python_binding", new)]
    pub fn new() -> Self {
        Self {
            pauli_error_rates: PauliErrorRates::default(),
            erasure_error_rate: 0.,
            correlated_pauli_error_rates: None,
            correlated_erasure_error_rates: None,
        }
    }

    /// check if this place has error rate = 0
    pub fn is_noiseless(&self) -> bool {
        if self.pauli_error_rates.error_probability() > 0. {
            return false;
        }
        if self.erasure_error_rate > 0. {
            return false;
        }
        if self.correlated_pauli_error_rates.is_some()
            && self.correlated_pauli_error_rates.as_ref().unwrap().error_probability() > 0.
        {
            return false;
        }
        if self.correlated_erasure_error_rates.is_some()
            && self.correlated_erasure_error_rates.as_ref().unwrap().error_probability() > 0.
        {
            return false;
        }
        true
    }
}

#[cfg_attr(feature = "python_binding", cfg_eval)]
#[cfg_attr(feature = "python_binding", pymethods)]
impl NoiseModel {
    #[cfg_attr(feature = "python_binding", new)]
    pub fn new(simulator: &Simulator) -> Self {
        assert!(simulator.volume() > 0, "cannot build noise model out of zero-sized simulator");
        let default_noise_model_node = Arc::new(NoiseModelNode::new());
        Self {
            nodes: (0..simulator.height)
                .map(|t| {
                    (0..simulator.vertical)
                        .map(|i| {
                            (0..simulator.horizontal)
                                .map(|j| {
                                    if simulator.is_node_exist(&pos!(t, i, j)) {
                                        Some(default_noise_model_node.clone())
                                    } else {
                                        None
                                    }
                                })
                                .collect()
                        })
                        .collect()
                })
                .collect(),
            additional_noise: vec![],
        }
    }
}

impl NoiseModel {
    /// judge if `[t][i][j]` is valid index of `self.nodes`
    #[inline]
    pub fn is_valid_position(&self, position: &Position) -> bool {
        position.t < self.nodes.len()
            && position.i < self.nodes[position.t].len()
            && position.j < self.nodes[position.t][position.i].len()
    }

    /// judge if `self.nodes[t][i][j]` is `Some(_)`
    #[inline]
    pub fn is_node_exist(&self, position: &Position) -> bool {
        self.is_valid_position(position) && self.get_node(position).is_some()
    }

    /// get `self.nodes[t][i][j]` without position check when compiled in release mode
    #[inline]
    pub fn get_node(&'_ self, position: &Position) -> &'_ Option<Arc<NoiseModelNode>> {
        &self.nodes[position.t][position.i][position.j]
    }

    /// get reference `self.nodes[t][i][j]` and then unwrap
    pub fn get_node_unwrap(&'_ self, position: &Position) -> &'_ NoiseModelNode {
        self.nodes[position.t][position.i][position.j].as_ref().unwrap()
    }

    /// get reference `self.nodes[t][i][j]` and then unwrap, returning a clone of the arc
    pub fn get_node_unwrap_arc(&'_ self, position: &Position) -> Arc<NoiseModelNode> {
        self.nodes[position.t][position.i][position.j].as_ref().unwrap().clone()
    }

    /// each node is immutable, but one can assign a new node
    pub fn set_node(&mut self, position: &Position, node: Option<Arc<NoiseModelNode>>) {
        self.nodes[position.t][position.i][position.j] = node;
    }
}

/// check if error rates are not zero at perfect measurement ranges or at (always) virtual nodes,
/// also check for error rate constrains on virtual nodes
pub fn noise_model_sanity_check(simulator: &Simulator, noise_model: &NoiseModel) -> Result<(), String> {
    let CodeSize { noisy_measurements, .. } = simulator.code_size;
    // check that no errors present in the final perfect measurement rounds
    let expected_height = simulator.measurement_cycles * (noisy_measurements + 1) + 1;
    if simulator.height != expected_height {
        return Err(format!(
            "height {} is not expected {}, don't know where is perfect measurement",
            simulator.height, expected_height
        ));
    }
    for t in simulator.height - simulator.measurement_cycles..simulator.height {
        simulator_iter!(simulator, position, _node, t => t, {
            let noise_model_node = noise_model.get_node_unwrap(position);
            if !noise_model_node.is_noiseless() {
                return Err(format!("detected noisy position {} within final perfect measurement", position))
            }
        });
    }
    // check all no error rate at virtual nodes
    simulator_iter_virtual!(simulator, position, _node, {
        // only check for virtual nodes
        let noise_model_node = noise_model.get_node_unwrap(position);
        if !noise_model_node.is_noiseless() {
            return Err(format!("detected noisy position {} which is virtual node", position));
        }
    });
    simulator_iter!(simulator, position, node, {
        let noise_model_node = noise_model.get_node_unwrap(position);
        if node.is_virtual {
            // no errors on virtual node is allowed, because they don't physically exist
            if noise_model_node.pauli_error_rates.error_probability() > 0. {
                return Err(format!(
                    "virtual position at {} have non-zero pauli_error_rates: {:?}",
                    position, noise_model_node.pauli_error_rates
                ));
            }
            if noise_model_node.erasure_error_rate > 0. {
                return Err(format!(
                    "virtual position at {} have non-zero erasure_error_rate: {}",
                    position, noise_model_node.erasure_error_rate
                ));
            }
            if let Some(correlated_pauli_error_rates) = &noise_model_node.correlated_pauli_error_rates {
                if correlated_pauli_error_rates.error_probability() > 0. {
                    return Err(format!(
                        "virtual position at {} have non-zero correlated_pauli_error_rates: {:?}",
                        position, correlated_pauli_error_rates
                    ));
                }
            }
            if let Some(correlated_erasure_error_rates) = &noise_model_node.correlated_erasure_error_rates {
                if correlated_erasure_error_rates.error_probability() > 0. {
                    return Err(format!(
                        "virtual position at {} have non-zero correlated_erasure_error_rates: {:?}",
                        position, correlated_erasure_error_rates
                    ));
                }
            }
        }
        if node.is_peer_virtual {
            // no correlated errors if peer position is virtual, because this two-qubit gate doesn't physically exist
            if let Some(correlated_pauli_error_rates) = &noise_model_node.correlated_pauli_error_rates {
                if correlated_pauli_error_rates.error_probability() > 0. {
                    return Err(format!(
                        "position at {} have virtual peer but non-zero correlated_pauli_error_rates: {:?}",
                        position, correlated_pauli_error_rates
                    ));
                }
            }
            if let Some(correlated_erasure_error_rates) = &noise_model_node.correlated_erasure_error_rates {
                if correlated_erasure_error_rates.error_probability() > 0. {
                    return Err(format!(
                        "position at {} have virtual peer but non-zero correlated_erasure_error_rates: {:?}",
                        position, correlated_erasure_error_rates
                    ));
                }
            }
        }
    });
    Ok(())
}

#[cfg(feature = "python_binding")]
#[pyfunction]
pub(crate) fn register(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
    m.add_class::<NoiseModel>()?;
    m.add_class::<NoiseModelNode>()?;
    m.add_class::<AdditionalNoise>()?;
    Ok(())
}