Add rem_euclid comment

Qiskit · Mar 2, 2023 · 95f6974 · 95f6974
1 parent 5745c83
commit 95f6974
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/euler_one_qubit_decomposer.rs b/src/euler_one_qubit_decomposer.rs
@@ -651,6 +651,9 @@ fn complex_phase(x: Complex64) -> f64 {
 
 #[inline]
 fn mod_2pi(angle: 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
 }