Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Leverage Rust circuit sequence construction for OneQubitEulerDecomposer #9583

Merged
merged 5 commits into from
Mar 17, 2023
Merged

Leverage Rust circuit sequence construction for OneQubitEulerDecomposer #9583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0aab5ae
Leverage Rust circuit sequence construction for OneQubitEulerDecomposer
mtreinish Feb 14, 2023
5f71cd8
Add missing atol clamping to mod_2pi
mtreinish Mar 3, 2023
d668a0d
Merge remote-tracking branch 'origin/main' into one-qubit-qi-rusty-euler
mtreinish Mar 8, 2023
bcf0546
Add docstring to mod_2pi rust function
mtreinish Mar 8, 2023
64a59ee
Remove mod_2pi python function
mtreinish Mar 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
71 changes: 46 additions & 25 deletions crates/accelerate/src/euler_one_qubit_decomposer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ fn circuit_kak(
// NOTE: The following normalization is safe, because the gphase correction below
// fixes a particular diagonal entry to 1, which prevents any potential phase
// slippage coming from _mod_2pi injecting multiples of 2pi.
lam = mod_2pi(lam);
lam = mod_2pi(lam, atol);
if lam.abs() > atol {
circuit.push((String::from(k_gate), vec![lam]));
global_phase += lam / 2.;
Expand All @@ -170,18 +170,18 @@ fn circuit_kak(
lam -= phi;
phi = 0.;
}
if mod_2pi(lam + PI).abs() < atol || mod_2pi(phi + PI).abs() < atol {
if mod_2pi(lam + PI, atol).abs() < atol || mod_2pi(phi + PI, atol).abs() < atol {
lam += PI;
theta = -theta;
phi += PI;
}
lam = mod_2pi(lam);
lam = mod_2pi(lam, atol);
if lam.abs() > atol {
global_phase += lam / 2.;
circuit.push((String::from(k_gate), vec![lam]));
}
circuit.push((String::from(a_gate), vec![theta]));
phi = mod_2pi(phi);
phi = mod_2pi(phi, atol);
if phi.abs() > atol {
global_phase += phi / 2.;
circuit.push((String::from(k_gate), vec![phi]));
Expand All @@ -201,12 +201,12 @@ fn circuit_u3(
atol: Option<f64>,
) -> OneQubitGateSequence {
let mut circuit = Vec::new();
let phi = mod_2pi(phi);
let lam = mod_2pi(lam);
let atol = match atol {
Some(atol) => atol,
None => DEFAULT_ATOL,
};
let phi = mod_2pi(phi, atol);
let lam = mod_2pi(lam, atol);
if !simplify || theta.abs() > atol || phi.abs() > atol || lam.abs() > atol {
circuit.push((String::from("u3"), vec![theta, phi, lam]));
}
Expand All @@ -233,14 +233,20 @@ fn circuit_u321(
atol = -1.0;
}
if theta.abs() < atol {
let tot = mod_2pi(phi + lam);
let tot = mod_2pi(phi + lam, atol);
if tot.abs() > atol {
circuit.push((String::from("u1"), vec![tot]));
}
} else if (theta - PI / 2.).abs() < atol {
circuit.push((String::from("u2"), vec![mod_2pi(phi), mod_2pi(lam)]));
circuit.push((
String::from("u2"),
vec![mod_2pi(phi, atol), mod_2pi(lam, atol)],
));
} else {
circuit.push((String::from("u3"), vec![theta, mod_2pi(phi), mod_2pi(lam)]));
circuit.push((
String::from("u3"),
vec![theta, mod_2pi(phi, atol), mod_2pi(lam, atol)],
));
}
OneQubitGateSequence {
gates: circuit,
Expand All @@ -264,8 +270,8 @@ fn circuit_u(
if !simplify {
atol = -1.0;
}
let phi = mod_2pi(phi);
let lam = mod_2pi(lam);
let phi = mod_2pi(phi, atol);
let lam = mod_2pi(lam, atol);
if theta.abs() > atol || phi.abs() > atol || lam.abs() > atol {
circuit.push((String::from("u"), vec![theta, phi, lam]));
}
Expand Down Expand Up @@ -323,7 +329,7 @@ where
phi -= lam;
lam = 0.;
}
if mod_2pi(lam + PI).abs() < atol || mod_2pi(phi).abs() < atol {
if mod_2pi(lam + PI, atol).abs() < atol || mod_2pi(phi, atol).abs() < atol {
lam += PI;
theta = -theta;
phi += PI;
Expand All @@ -338,7 +344,7 @@ where
// emit circuit
pfun(&mut circuit, lam);
match xpifun {
Some(xpifun) if mod_2pi(theta).abs() < atol => xpifun(&mut circuit),
Some(xpifun) if mod_2pi(theta, atol).abs() < atol => xpifun(&mut circuit),
_ => {
xfun(&mut circuit);
pfun(&mut circuit, theta);
Expand Down Expand Up @@ -372,9 +378,15 @@ fn circuit_rr(
};
}
if (theta - PI).abs() > atol {
circuit.push((String::from("r"), vec![theta - PI, mod_2pi(PI / 2. - lam)]));
}
circuit.push((String::from("r"), vec![PI, mod_2pi(0.5 * (phi - lam + PI))]));
circuit.push((
String::from("r"),
vec![theta - PI, mod_2pi(PI / 2. - lam, atol)],
));
}
circuit.push((
String::from("r"),
vec![PI, mod_2pi(0.5 * (phi - lam + PI), atol)],
));
OneQubitGateSequence {
gates: circuit,
global_phase: phase,
Expand Down Expand Up @@ -408,7 +420,7 @@ pub fn generate_circuit(
inner_atol = -1.0;
}
let fnz = |circuit: &mut OneQubitGateSequence, phi: f64| {
let phi = mod_2pi(phi);
let phi = mod_2pi(phi, inner_atol);
if phi.abs() > inner_atol {
circuit.gates.push((String::from("p"), vec![phi]));
}
Expand Down Expand Up @@ -438,7 +450,7 @@ pub fn generate_circuit(
inner_atol = -1.0;
}
let fnz = |circuit: &mut OneQubitGateSequence, phi: f64| {
let phi = mod_2pi(phi);
let phi = mod_2pi(phi, inner_atol);
if phi.abs() > inner_atol {
circuit.gates.push((String::from("rz"), vec![phi]));
circuit.global_phase += phi / 2.;
Expand Down Expand Up @@ -468,7 +480,7 @@ pub fn generate_circuit(
inner_atol = -1.0;
}
let fnz = |circuit: &mut OneQubitGateSequence, phi: f64| {
let phi = mod_2pi(phi);
let phi = mod_2pi(phi, inner_atol);
if phi.abs() > inner_atol {
circuit.gates.push((String::from("u1"), vec![phi]));
}
Expand Down Expand Up @@ -498,7 +510,7 @@ pub fn generate_circuit(
inner_atol = -1.0;
}
let fnz = |circuit: &mut OneQubitGateSequence, phi: f64| {
let phi = mod_2pi(phi);
let phi = mod_2pi(phi, inner_atol);
if phi.abs() > inner_atol {
circuit.gates.push((String::from("rz"), vec![phi]));
circuit.global_phase += phi / 2.;
Expand Down Expand Up @@ -608,11 +620,14 @@ pub fn compute_error_list(
}

#[pyfunction]
#[pyo3(signature = (unitary, target_basis_list, qubit, error_map=None, simplify=true, atol=None))]
pub fn unitary_to_gate_sequence(
unitary: PyReadonlyArray2<Complex64>,
target_basis_list: Vec<&str>,
qubit: usize,
error_map: Option<&OneQubitGateErrorMap>,
simplify: bool,
atol: Option<f64>,
) -> PyResult<Option<OneQubitGateSequence>> {
const VALID_BASES: [&str; 12] = [
"U321", "U3", "U", "PSX", "ZSX", "ZSXX", "U1X", "RR", "ZYZ", "ZXZ", "XYX", "XZX",
Expand All @@ -629,7 +644,7 @@ pub fn unitary_to_gate_sequence(
.iter()
.map(|target_basis| {
let [theta, phi, lam, phase] = angles_from_unitary(unitary_mat, target_basis);
generate_circuit(target_basis, theta, phi, lam, phase, true, None).unwrap()
generate_circuit(target_basis, theta, phi, lam, phase, simplify, atol).unwrap()
})
.min_by(|a, b| {
let error_a = compare_error_fn(a, &error_map, qubit);
Expand All @@ -649,12 +664,18 @@ fn complex_phase(x: Complex64) -> f64 {
x.im.atan2(x.re)
}

/// Wrap angle into interval [-π,π). If within atol of the endpoint, clamp to -π
#[inline]
fn mod_2pi(angle: f64) -> f64 {
fn mod_2pi(angle: f64, atol: f64) -> f64 {
// f64::rem_euclid() isn't exactly the same as Python's % operator, but because
// the RHS here is a constant and positive it is effectively equivalent for
// this case
(angle + PI).rem_euclid(2. * PI) - PI
let wrapped = (angle + PI).rem_euclid(2. * PI) - PI;
if (wrapped - PI).abs() < atol {
-PI
} else {
wrapped
}
Comment on lines +667 to +678
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was going to complain that this only clips near the +pi end, not near -pi, but it's pre-existing in the Python implementation, so we can leave it.

}

fn params_zyz_inner(mat: ArrayView2<Complex64>) -> [f64; 4] {
Expand Down Expand Up @@ -722,8 +743,8 @@ fn params_xyx_inner(mat: ArrayView2<Complex64>) -> [f64; 4] {
],
]);
let [theta, phi, lam, phase] = params_zyz_inner(mat_zyz.view());
let new_phi = mod_2pi(phi + PI);
let new_lam = mod_2pi(lam + PI);
let new_phi = mod_2pi(phi + PI, 0.);
let new_lam = mod_2pi(lam + PI, 0.);
[
theta,
new_phi,
Expand Down