refactor(hseries): use array unpack operation (#913)

Handles a test failure induced by update to hugr 0.20.2 (bug in release)

Author: ss2165

.github/change-filters.yml

@@ -21,4 +21,4 @@ python:
   - "uv.lock"
 
 extensions:
-  - "tket2-exts/src/tket2_exts/data/tket2/**"
+  - "tket2-exts/src/tket2_exts/data/tket2/**"

.gitignore

@@ -25,3 +25,5 @@ lcov.info
 # local cargo config
 /.cargo/config.toml
 .envrc
+
+.DS_Store

Cargo.lock

@@ -37,17 +37,19 @@ large_enum_variant = "allow"
 [patch.crates-io]
 
 # Uncomment to use unreleased versions of hugr
-#hugr = { git = "https://github.com/CQCL/hugr", rev = "42ce05d" }
-#hugr-core = { git = "https://github.com/CQCL/hugr", rev = "42ce05d" }
-#hugr-passes = { git = "https://github.com/CQCL/hugr", rev = "42ce05d" }
-#hugr-cli = { git = "https://github.com/CQCL/hugr", rev = "42ce05d" }
+# hugr = { git = "https://github.com/CQCL/hugr", branch = "ss/push-xvxtzqlwkvux" }
+# hugr-core = { git = "https://github.com/CQCL/hugr", branch = "ss/push-xvxtzqlwkvux" }
+# hugr-passes = { git = "https://github.com/CQCL/hugr", branch = "ss/push-xvxtzqlwkvux" }
+# hugr-cli = { git = "https://github.com/CQCL/hugr", branch = "ss/push-xvxtzqlwkvux" }
+
+
 # portgraph = { git = "https://github.com/CQCL/portgraph", rev = "68b96ac737e0c285d8c543b2d74a7aa80a18202c" }
 [workspace.dependencies]
 
 # Make sure to run `just recompile-eccs` if the hugr serialisation format changes.
-hugr = "0.20.1"
-hugr-core = "0.20.1"
-hugr-cli = "0.20.1"
+hugr = "0.20.2"
+hugr-core = "0.20.2"
+hugr-cli = "0.20.2"
 portgraph = "0.14.1"
 pyo3 = ">= 0.23.4, < 0.26"
 itertools = "0.14.0"

Cargo.toml

@@ -22,7 +22,7 @@ use hugr::{
             float_ops::FloatOps,
             float_types::{float64_type, ConstF64, EXTENSION as FLOAT_TYPES},
         },
-        collections::array::{array_type, array_type_parametric, ArrayOpBuilder},
+        collections::array::{array_type_parametric, ArrayOpBuilder},
     },
     type_row,
     types::{type_param::TypeParam, PolyFuncType, Signature, Type, TypeArg, TypeRow},
@@ -511,7 +511,7 @@ pub trait QSystemOpBuilder: Dataflow + UnwrapBuilder + ArrayOpBuilder {
         let q_arr = self.add_new_array(qb_t(), qbs)?;
         let q_arr = self.add_runtime_barrier(q_arr, size)?;
 
-        pop_all(self, q_arr, size, qb_t())
+        self.add_array_unpack(qb_t(), size, q_arr)
     }
 }
 
@@ -525,40 +525,6 @@ pub(crate) fn runtime_barrier_ext_op(
     )
 }
 
-/// Build a pop left operation on an array and unwrap the resulting option.
-pub(crate) fn pop_unwrap<T: ArrayOpBuilder>(
-    builder: &mut T,
-    q_arr: Wire,
-    size: u64,
-    elem_ty: Type,
-) -> Result<[Wire; 2], BuildError> {
-    debug_assert!(size > 0);
-    let r = builder
-        .add_array_pop_right(elem_ty.clone(), size, q_arr)
-        .unwrap();
-    builder.build_unwrap_sum(
-        1,
-        option_type(vec![elem_ty.clone(), array_type(size - 1, elem_ty)]),
-        r,
-    )
-}
-/// Unpack all elements of an array and discard the empty array.
-pub(crate) fn pop_all<T: ArrayOpBuilder>(
-    builder: &mut T,
-    mut arr: Wire,
-    size: u64,
-    elem_ty: Type,
-) -> Result<Vec<Wire>, BuildError> {
-    // TODO use unwrap op when available https://github.com/CQCL/hugr/issues/1947
-    let mut result = Vec::with_capacity(size as usize);
-    for ar_size in (1..size + 1).rev() {
-        let [qb, new_arr] = pop_unwrap(builder, arr, ar_size, elem_ty.clone())?;
-        result.push(qb);
-        arr = new_arr;
-    }
-    builder.add_array_discard_empty(elem_ty, arr)?;
-    Ok(result)
-}
 impl<D: Dataflow> QSystemOpBuilder for D {}
 
 #[cfg(test)]

tket2-hseries/src/extension/qsystem.rs

@@ -325,7 +325,7 @@ impl BarrierOperationFactory {
             [array_wire],
             |slf, func_b| {
                 let w = func_b.input().out_wire(0);
-                let elems = crate::extension::qsystem::pop_all(func_b, w, size, elem_ty.clone())?;
+                let elems = func_b.add_array_unpack(elem_ty.clone(), size, w)?;
                 let unpacked: Vec<_> = elems
                     .into_iter()
                     .map(|wire| slf.unpack_container(func_b, elem_ty, wire))

tket2-hseries/src/extension/qsystem/barrier/barrier_ops.rs

@@ -383,8 +383,8 @@ mod test {
         // dfg, input, output, alloc + (10 for unwrap), phasedx, rz, toturns, fmul, phasedx, free +
         // 5x(float + load), measure_reset, conditional, case(input, output) * 2, flip
         // (phasedx + 2*(float + load)), tket2.read
-        // + 19 for the barrier array wrapping, popping and option unwrapping
-        assert_eq!(h.descendants(h.module_root()).count(), 83);
+        // + 10 for the barrier array wrapping, unwrapping and option unwrapping
+        assert_eq!(h.descendants(h.module_root()).count(), 72);
         assert_eq!(check_lowered(&h), Ok(()));
         if let Err(e) = h.validate() {
             panic!("{}", e);

tket2-hseries/src/extension/qsystem/lower.rs

@@ -218,7 +218,7 @@ impl QSystemPass {
 #[cfg(test)]
 mod test {
     use hugr::{
-        builder::{Container, DFGBuilder, Dataflow, DataflowHugr, DataflowSubContainer},
+        builder::{Container, Dataflow, DataflowSubContainer, HugrBuilder},
         extension::prelude::qb_t,
         ops::handle::NodeHandle,
         std_extensions::arithmetic::float_types::ConstF64,
@@ -238,13 +238,19 @@ mod test {
 
     #[test]
     fn qsystem_pass() {
+        let mut mb = hugr::builder::ModuleBuilder::new();
+        let func = mb
+            .define_function("func", Signature::new_endo(type_row![]))
+            .unwrap()
+            .finish_with_outputs([])
+            .unwrap();
+
         let (mut hugr, [call_node, h_node, f_node, rx_node]) = {
-            let mut builder =
-                DFGBuilder::new(Signature::new(qb_t(), vec![bool_type(), bool_type()])).unwrap();
-            let func = builder
-                .define_function("func", Signature::new_endo(type_row![]))
-                .unwrap()
-                .finish_with_outputs([])
+            let mut builder = mb
+                .define_function(
+                    "main",
+                    Signature::new(qb_t(), vec![bool_type(), bool_type()]),
+                )
                 .unwrap();
             let [qb] = builder.input_wires_arr();
 
@@ -278,12 +284,12 @@ mod test {
                 .unwrap()
                 .outputs_arr();
 
-            let hugr = builder
-                .finish_hugr_with_outputs([measure_result, measure_result])
+            let _main_n = builder
+                .finish_with_outputs([measure_result, measure_result])
                 .unwrap();
+            let hugr = mb.finish_hugr().unwrap();
             (hugr, [call_node, h_node, f_node, rx_node])
         };
-
         QSystemPass::default().run(&mut hugr).unwrap();
 
         let topo_sorted = Topo::new(&hugr.as_petgraph())

tket2-hseries/src/lib.rs

@@ -12,7 +12,7 @@ pub use ecc_rewriter::ECCRewriter;
 use derive_more::{From, Into};
 use hugr::core::HugrNode;
 use hugr::hugr::hugrmut::HugrMut;
-use hugr::hugr::patch::{simple_replace, PatchVerification};
+use hugr::hugr::patch::simple_replace;
 use hugr::hugr::views::sibling_subgraph::{InvalidReplacement, InvalidSubgraph};
 use hugr::hugr::Patch;
 use hugr::types::Signature;