feat!: Add original circuit/subgraphs in pytket DecoderCtx

Author: aborgna-q

tket-py/src/circuit/convert.rs

@@ -70,7 +70,7 @@ where
         Err(_) => (
             SerialCircuit::from_tket1(circ)?
                 .decode(
-                    DecodeOptions::new()
+                    DecodeOptions::new_any()
                         .with_config(tket_qsystem::pytket::qsystem_decoder_config()),
                 )
                 .convert_pyerrs()?,

tket-qsystem/src/pytket.rs

@@ -15,7 +15,7 @@ use tket::serialize::pytket::{
 ///
 /// Contains a list of custom decoders that define translations of legacy tket
 /// primitives into HUGR operations.
-pub fn qsystem_decoder_config() -> PytketDecoderConfig {
+pub fn qsystem_decoder_config<H: HugrView>() -> PytketDecoderConfig<H> {
     let mut config = default_decoder_config();
     config.add_decoder(QSystemEmitter);
 

tket-qsystem/src/pytket/qsystem.rs

@@ -115,7 +115,7 @@ impl QSystemEmitter {
     }
 }
 
-impl PytketDecoder for QSystemEmitter {
+impl<H: HugrView> PytketDecoder<H> for QSystemEmitter {
     fn op_types(&self) -> Vec<PytketOptype> {
         // Process native optypes that are not supported by the `TketOp` emitter.
         vec![
@@ -132,7 +132,7 @@ impl PytketDecoder for QSystemEmitter {
         bits: &[TrackedBit],
         params: &[LoadedParameter],
         _opgroup: Option<&str>,
-        decoder: &mut PytketDecoderContext<'h>,
+        decoder: &mut PytketDecoderContext<'h, H>,
     ) -> Result<DecodeStatus, PytketDecodeError> {
         let op = match op.op_type {
             PytketOptype::PhasedX => QSystemOp::PhasedX,

tket-qsystem/src/pytket/tests.rs

@@ -198,7 +198,7 @@ fn json_roundtrip(
     assert_eq!(ser.commands.len(), num_commands);
 
     let circ: Circuit = ser
-        .decode(DecodeOptions::new().with_config(qsystem_decoder_config()))
+        .decode(DecodeOptions::new_any().with_config(qsystem_decoder_config()))
         .unwrap();
     assert_eq!(circ.qubit_count(), num_qubits);
 
@@ -229,7 +229,7 @@ fn circuit_roundtrip(#[case] circ: Circuit, #[case] decoded_sig: Signature) {
     )
     .unwrap();
     let deser: Circuit = ser
-        .decode(DecodeOptions::new().with_config(qsystem_decoder_config()))
+        .decode(DecodeOptions::new_any().with_config(qsystem_decoder_config()))
         .unwrap();
 
     let deser_sig = deser.circuit_signature();

tket/src/circuit/hash.rs

@@ -208,7 +208,7 @@ mod test {
     fn hash_constants() {
         let c_str = r#"{"bits": [], "commands": [{"args": [["q", [0]]], "op": {"params": ["0.5"], "type": "Rz"}}], "created_qubits": [], "discarded_qubits": [], "implicit_permutation": [[["q", [0]], ["q", [0]]]], "phase": "0.0", "qubits": [["q", [0]]]}"#;
         let ser: circuit_json::SerialCircuit = serde_json::from_str(c_str).unwrap();
-        let circ: Circuit = ser.decode(DecodeOptions::new()).unwrap();
+        let circ: Circuit = ser.decode(DecodeOptions::new_any()).unwrap();
         circ.circuit_hash(circ.parent()).unwrap();
     }
 
@@ -220,7 +220,7 @@ mod test {
         let mut all_hashes = Vec::with_capacity(2);
         for c_str in [c_str1, c_str2] {
             let ser: circuit_json::SerialCircuit = serde_json::from_str(c_str).unwrap();
-            let circ: Circuit = ser.decode(DecodeOptions::new()).unwrap();
+            let circ: Circuit = ser.decode(DecodeOptions::new_any()).unwrap();
             all_hashes.push(circ.circuit_hash(circ.parent()).unwrap());
         }
         assert_ne!(all_hashes[0], all_hashes[1]);

tket/src/serialize/pytket.rs

@@ -21,7 +21,7 @@ pub use options::{DecodeInsertionTarget, DecodeOptions, EncodeOptions};
 
 use hugr::hugr::hugrmut::HugrMut;
 use hugr::ops::handle::NodeHandle;
-use hugr::{Hugr, Node};
+use hugr::{Hugr, HugrView, Node};
 #[cfg(test)]
 mod tests;
 
@@ -70,7 +70,7 @@ pub trait TKETDecode: Sized {
     /// # Returns
     ///
     /// The encoded circuit.
-    fn decode(&self, options: DecodeOptions) -> Result<Circuit, Self::DecodeError>;
+    fn decode(&self, options: DecodeOptions<impl HugrView>) -> Result<Circuit, Self::DecodeError>;
     /// Convert the serialized circuit into a function definition in an existing HUGR.
     ///
     /// Does **not** modify the HUGR's entrypoint.
@@ -92,7 +92,7 @@ pub trait TKETDecode: Sized {
         // (so that the extension decoder traits are dyn-compatible).
         hugr: &mut Hugr,
         target: DecodeInsertionTarget,
-        options: DecodeOptions,
+        options: DecodeOptions<impl HugrView>,
     ) -> Result<Node, Self::DecodeError>;
     /// Convert a circuit to a serialized pytket circuit.
     ///
@@ -113,9 +113,13 @@ impl TKETDecode for SerialCircuit {
     type DecodeError = PytketDecodeError;
     type EncodeError = PytketEncodeError;
 
-    fn decode(&self, options: DecodeOptions) -> Result<Circuit, Self::DecodeError> {
+    fn decode(&self, options: DecodeOptions<impl HugrView>) -> Result<Circuit, Self::DecodeError> {
         let mut hugr = Hugr::new();
-        let main_func = self.decode_inplace(&mut hugr, DecodeInsertionTarget::Function, options)?;
+        let main_func = self.decode_inplace(
+            &mut hugr,
+            DecodeInsertionTarget::Function { fn_name: None },
+            options,
+        )?;
         hugr.set_entrypoint(main_func);
         Ok(hugr.into())
     }
@@ -124,7 +128,7 @@ impl TKETDecode for SerialCircuit {
         &self,
         hugr: &mut Hugr,
         target: DecodeInsertionTarget,
-        options: DecodeOptions,
+        options: DecodeOptions<impl HugrView>,
     ) -> Result<Node, Self::DecodeError> {
         let config = options
             .config
@@ -134,7 +138,6 @@ impl TKETDecode for SerialCircuit {
             self,
             hugr,
             target,
-            options.fn_name,
             options.signature,
             options.input_params,
             config,

tket/src/serialize/pytket/circuit.rs

@@ -4,13 +4,18 @@ use std::collections::{HashMap, VecDeque};
 use std::ops::{Index, IndexMut};
 
 use hugr::core::HugrNode;
+use hugr::hugr::hugrmut::HugrMut;
+use hugr::ops::handle::NodeHandle;
 use hugr::ops::{OpTag, OpTrait};
-use hugr::{Hugr, HugrView};
+use hugr::{Hugr, HugrView, Node};
 use rayon::iter::{IntoParallelIterator, IntoParallelRefIterator, IntoParallelRefMutIterator};
 use tket_json_rs::circuit_json::{Command as PytketCommand, SerialCircuit};
 
+use crate::serialize::pytket::decoder::PytketDecoderContext;
 use crate::serialize::pytket::{
-    default_encoder_config, EncodeOptions, PytketEncodeError, PytketEncoderContext,
+    default_decoder_config, default_encoder_config, DecodeInsertionTarget, DecodeOptions,
+    EncodeOptions, PytketDecodeError, PytketDecodeErrorInner, PytketEncodeError,
+    PytketEncoderContext,
 };
 use crate::Circuit;
 
@@ -146,6 +151,97 @@ impl<'a, H: HugrView> EncodedCircuit<'a, H> {
         Ok(())
     }
 
+    /// Reassemble the encoded circuits into a new [`Hugr`], containing a
+    /// function defining the [`Self::head_region`] and expanding any opaque
+    /// hugrs in pytket barrier operations back into Hugr subgraphs.
+    ///
+    /// Functions called by the internal hugrs may be added to the hugr module
+    /// as well.
+    ///
+    /// # Arguments
+    ///
+    /// - `fn_name`: The name of the function to create. If `None`, we will use
+    ///   the name of the circuit, or "main" if the circuit has no name.
+    /// - `options`: The options for the decoder.
+    ///
+    /// # Errors
+    ///
+    /// Returns a [`PytketDecodeErrorInner::NonDataflowHeadRegion`] error if
+    /// [`Self::head_region`] is not a dataflow container in the hugr.
+    ///
+    /// Returns an error if a circuit being decoded is invalid. See
+    /// [`PytketDecodeErrorInner`][super::error::PytketDecodeErrorInner] for
+    /// more details.
+    pub fn reassemble(
+        &self,
+        fn_name: Option<String>,
+        options: DecodeOptions<H>,
+    ) -> Result<Hugr, PytketDecodeError> {
+        let mut hugr = Hugr::new();
+        let main_func = self.reassemble_inline(
+            &mut hugr,
+            DecodeInsertionTarget::Function { fn_name },
+            options,
+        )?;
+        hugr.set_entrypoint(main_func);
+        Ok(hugr)
+    }
+
+    /// Reassemble the encoded circuits inside an existing [`Hugr`], containing
+    /// the [`Self::head_region`] at the given insertion target.
+    ///
+    /// Functions called by the internal hugrs may be added to the hugr module
+    /// as well.
+    ///
+    /// # Arguments
+    ///
+    /// - `hugr`: The [`Hugr`] to reassemble the circuits in.
+    /// - `target`: The target to insert the function at.
+    /// - `options`: The options for the decoder.
+    ///
+    /// # Errors
+    ///
+    /// Returns a [`PytketDecodeErrorInner::NonDataflowHeadRegion`] error if
+    /// [`Self::head_region`] is not a dataflow container in the hugr.
+    ///
+    /// Returns an error if a circuit being decoded is invalid. See
+    /// [`PytketDecodeErrorInner`][super::error::PytketDecodeErrorInner] for
+    /// more details.
+    pub fn reassemble_inline(
+        &self,
+        hugr: &mut Hugr,
+        target: DecodeInsertionTarget,
+        options: DecodeOptions<H>,
+    ) -> Result<Node, PytketDecodeError> {
+        if !self.check_dataflow_head_region() {
+            let head_op = self.hugr.get_optype(self.head_region).to_string();
+            return Err(PytketDecodeErrorInner::NonDataflowHeadRegion { head_op }.wrap());
+        };
+        let serial_circuit = &self[self.head_region];
+
+        if self.len() > 1 {
+            unimplemented!(
+                "Reassembling an `EncodedCircuit` with nested subcircuits is not yet implemented."
+            );
+        };
+
+        let config = options
+            .config
+            .unwrap_or_else(|| default_decoder_config().into());
+
+        let mut decoder = PytketDecoderContext::<H>::new(
+            serial_circuit,
+            hugr,
+            target,
+            options.signature,
+            options.input_params,
+            config,
+        )?;
+        decoder.register_unsupported_subgraphs(&self.opaque_subgraphs, self.hugr);
+        decoder.run_decoder(&serial_circuit.commands)?;
+        Ok(decoder.finish()?.node())
+    }
+
     /// Extract the top-level pytket circuit as a standalone definition
     /// containing the whole original HUGR.
     ///

tket/src/serialize/pytket/config.rs

@@ -18,7 +18,7 @@ use hugr::HugrView;
 ///
 /// Contains a list of custom decoders that define translations of legacy tket
 /// primitives into HUGR operations.
-pub fn default_decoder_config() -> PytketDecoderConfig {
+pub fn default_decoder_config<H: HugrView>() -> PytketDecoderConfig<H> {
     let mut config = PytketDecoderConfig::new();
     config.add_decoder(CoreDecoder);
     config.add_decoder(PreludeEmitter);

tket/src/serialize/pytket/config/decoder_config.rs

@@ -5,6 +5,7 @@
 //! translations of legacy tket primitives into HUGR operations.
 
 use hugr::types::Type;
+use hugr::HugrView;
 use itertools::Itertools;
 use std::collections::HashMap;
 
@@ -22,10 +23,10 @@ use super::TypeTranslatorSet;
 /// Contains custom decoders that define translations for HUGR operations,
 /// types, and consts into pytket primitives.
 #[derive(Default, derive_more::Debug)]
-pub struct PytketDecoderConfig {
+pub struct PytketDecoderConfig<H: HugrView> {
     /// Operation emitters
     #[debug(skip)]
-    pub(super) decoders: Vec<Box<dyn PytketDecoder + Send + Sync>>,
+    pub(super) decoders: Vec<Box<dyn PytketDecoder<H> + Send + Sync>>,
     /// Pre-computed map from pytket optypes to corresponding decoders in
     /// `decoders`, identified by their index.
     #[debug("{:?}", optype_decoders.keys().collect_vec())]
@@ -34,7 +35,7 @@ pub struct PytketDecoderConfig {
     type_translators: TypeTranslatorSet,
 }
 
-impl PytketDecoderConfig {
+impl<H: HugrView> PytketDecoderConfig<H> {
     /// Create a new [`PytketDecoderConfig`] with no decoders.
     pub fn new() -> Self {
         Self {
@@ -45,7 +46,7 @@ impl PytketDecoderConfig {
     }
 
     /// Add a decoder to the configuration.
-    pub fn add_decoder(&mut self, decoder: impl PytketDecoder + Send + Sync + 'static) {
+    pub fn add_decoder(&mut self, decoder: impl PytketDecoder<H> + Send + Sync + 'static) {
         let idx = self.decoders.len();
 
         for optype in decoder.op_types() {
@@ -74,7 +75,7 @@ impl PytketDecoderConfig {
         bits: &[TrackedBit],
         params: &[LoadedParameter],
         opgroup: &Option<String>,
-        decoder: &mut PytketDecoderContext<'a>,
+        decoder: &mut PytketDecoderContext<'a, H>,
     ) -> Result<DecodeStatus, PytketDecodeError> {
         let mut result = DecodeStatus::Unsupported;
         let opgroup = opgroup.as_deref();
@@ -91,7 +92,7 @@ impl PytketDecoderConfig {
     fn decoders_for_optype(
         &self,
         optype: &tket_json_rs::OpType,
-    ) -> impl Iterator<Item = &Box<dyn PytketDecoder + Send + Sync>> {
+    ) -> impl Iterator<Item = &Box<dyn PytketDecoder<H> + Send + Sync>> {
         self.optype_decoders
             .get(optype)
             .into_iter()