implement rewriting logic on ResourceScope

Author: lmondada

tket/examples/circuit-matcher.rs

@@ -103,7 +103,7 @@ impl CircuitMatcher for CliffordMatcher {
 fn main() {
     const CIRCUIT: &str = r#"{"bits": [], "commands": [{"args": [["q", [0]], ["q", [1]]], "op": {"type": "CX"}}, {"args": [["q", [0]]], "op": {"params": ["0.5"], "type": "Rz"}}, {"args": [["q", [1]]], "op": {"type": "V"}}, {"args": [["q", [0]], ["q", [2]]], "op": {"type": "CX"}}, {"args": [["q", [0]], ["q", [1]]], "op": {"type": "CX"}}, {"args": [["q", [2]]], "op": {"type": "S"}}, {"args": [["q", [0]]], "op": {"params": ["0.111"], "type": "Rz"}}, {"args": [["q", [2]]], "op": {"type": "T"}}, {"args": [["q", [1]], ["q", [2]]], "op": {"type": "CX"}}, {"args": [["q", [1]]], "op": {"type": "T"}}, {"args": [["q", [2]]], "op": {"type": "S"}}, {"args": [["q", [0]], ["q", [1]]], "op": {"type": "CX"}}], "created_qubits": [], "discarded_qubits": [], "implicit_permutation": [[["q", [0]], ["q", [0]]], [["q", [1]], ["q", [1]]], [["q", [2]], ["q", [2]]]], "phase": "0.0", "qubits": [["q", [0]], ["q", [1]], ["q", [2]]]}"#;
     let ser_circ: SerialCircuit = serde_json::from_str(CIRCUIT).unwrap();
-    let circuit = ResourceScope::from_circuit(ser_circ.decode().unwrap());
+    let circuit = ResourceScope::from_circuit(ser_circ.decode(Default::default()).unwrap());
 
     let matcher = CliffordMatcher {
         allowed_num_cx: 2..4,

tket/src/resource.rs

@@ -54,7 +54,7 @@ use hugr::{
 };
 pub use interval::{Interval, InvalidInterval};
 use itertools::Itertools;
-pub use scope::{ResourceScope, ResourceScopeConfig};
+pub use scope::{CircuitRewriteError, ResourceScope, ResourceScopeConfig};
 pub use types::{CircuitUnit, Position, ResourceAllocator, ResourceId};
 
 use crate::{
@@ -82,7 +82,8 @@ impl<H: HugrMut> ResourceScope<H> {
 
     /// Register a rewrite applied to the circuit.
     ///
-    /// Returns `true` if the rewrite was successfully registered, or `false` if it was ignored.
+    /// Returns `true` if the rewrite was successfully registered, or `false` if
+    /// it was ignored.
     #[inline]
     pub fn add_rewrite_trace(&mut self, rewrite: impl Into<RewriteTrace>) -> bool {
         self.as_circuit_mut().add_rewrite_trace(rewrite)

tket/src/resource/scope.rs

@@ -4,8 +4,10 @@
 //! tracking within a specific region of a HUGR, computing resource paths and
 //! providing efficient lookup of circuit units associated with ports.
 
-use std::collections::BTreeSet;
-use std::{cmp, iter};
+mod patch;
+pub use patch::CircuitRewriteError;
+
+use std::{cmp, collections::BTreeSet, iter};
 
 use crate::resource::flow::{DefaultResourceFlow, ResourceFlow};
 use crate::resource::types::{CircuitUnit, PortMap};
@@ -185,17 +187,15 @@ impl<H: HugrView> ResourceScope<H> {
         self.hugr
     }
 
-    pub(crate) fn hugr_mut(&mut self) -> &mut H {
-        &mut self.hugr
-    }
-
     /// Wrap the underlying HUGR in a Circuit as reference.
     pub fn as_circuit(&self) -> Circuit<&H> {
         Circuit::new(self.hugr())
     }
 
-    pub(crate) fn as_circuit_mut(&mut self) -> Circuit<&mut H> {
-        Circuit::new(self.hugr_mut())
+    /// Careful: this will not update the circuit units, so do not modify
+    /// the HUGR using this.
+    pub(super) fn as_circuit_mut(&mut self) -> Circuit<&mut H> {
+        Circuit::new(&mut self.hugr)
     }
 
     /// Get the underlying subgraph, or `None` if the circuit is empty.