feat: Add PersistentHugr #2080

lmondada · 2025-04-15T10:48:24Z

~~The base of this PR will be moved to main once #2070 has been merged in.~~

~~Status: The API and main structs have been defined. Most of the core logic has yet to be implemented.~~

Status: PR is ready. The trait implementations for HugrView, VerifyPatch and ApplyPatch will be in a separate PR once progress on those is unblocked.

Closes #2096

lmondada · 2025-04-17T13:24:38Z

bus factor considerations: we might want to fold RelRc into Hugr at some point (at least the parts that we care about), but I'd suggest first figuring out what works/if it works before putting efforts into that.

…rsistenthugr

codecov · 2025-04-29T14:59:00Z

Codecov Report

Attention: Patch coverage is 89.54869% with 44 lines in your changes missing coverage. Please review.

Project coverage is 83.44%. Comparing base (f0738b1) to head (fd7662d).

Files with missing lines	Patch %	Lines
hugr-core/src/hugr/persistent/resolver.rs	15.00%	17 Missing ⚠️
hugr-core/src/hugr/persistent/state_space.rs	88.72%	11 Missing and 4 partials ⚠️
hugr-core/src/hugr/persistent.rs	90.32%	9 Missing and 3 partials ⚠️

Additional details and impacted files

@@                  Coverage Diff                   @@
##           release-rs-v0.16.0    #2080      +/-   ##
======================================================
+ Coverage               83.37%   83.44%   +0.06%     
======================================================
  Files                     219      223       +4     
  Lines                   42281    42702     +421     
  Branches                38383    38804     +421     
======================================================
+ Hits                    35252    35632     +380     
- Misses                   5209     5243      +34     
- Partials                 1820     1827       +7

Flag	Coverage Δ
python	`85.73% <ø> (ø)`
rust	`83.21% <89.54%> (+0.07%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

cqc-alec

Thanks, this looks great. Most of my comment are minor ones on the docs ... and some umming and aahing about the name.

cqc-alec · 2025-04-30T14:13:04Z

hugr-core/src/hugr/persistent/state_space.rs

+            .all_node_ids()
+            .exactly_one()
+            .ok()
+            .expect("just added one commit");


I think the expect message could be improved. What would the caller have done wrong to get this?

Does the new phrasing clarify things? This can never happen: graph was just created with a single commit, which will be the graph's only node.

cqc-alec · 2025-04-30T14:15:52Z

hugr-core/src/hugr/persistent/state_space.rs

+        if base_commits.len() != 1 {
+            Err(InvalidCommit::NonUniqueBase(base_commits.len()))
+        } else {
+            let base_commit = base_commits[0];
+            Ok(Self { graph, base_commit })
+        }


Can we use exactly_one() here for conciseness?

Yes absolutely, good spot!

cqc-alec · 2025-04-30T14:31:52Z

hugr-core/src/hugr/persistent/state_space.rs

+#[non_exhaustive]
+pub enum InvalidCommit {
+    /// The commit conflicts with existing commits in the state space.
+    #[error("Incompatible history: children commits conflict in {0:?} conflict in {1:?}")]


The message seems a bit garbled?

Indeed, fixed!

cqc-alec · 2025-04-30T15:02:11Z

hugr-core/src/hugr/persistent/tests.rs

+    let (base_hugr, nodes) = simple_hugr;
+    let base_hugr_clone = base_hugr.clone();
+
+    println!("{}", base_hugr.mermaid_string());


Do we want to keep these println!s in the tests?

That slipped through. Removed :)

cqc-alec · 2025-04-30T15:07:06Z

hugr-core/src/hugr/persistent/tests.rs

+    assert_eq!(direct_hugr.validate(), Ok(()));
+    assert_eq!(persistent_final_hugr.validate(), Ok(()));
+    assert_eq!(
+        direct_hugr.mermaid_string(),


Is this the best method we have for equality checking of hugrs?

It actually works with direct comparison! So will go with that, although this might break in the future if the node indexing changes for some reason.

Ideally, we'd use something like a hash-based comparison. I'll add a TODO comment about it

Actually, spoke too soon! This seems to be non-deterministic (maybe it depends on the total order in which replacements are applied?) :/

I've reverted to mermaid_string comparisons, but left the comment that we should ideally use hash-based comparisons once this is implemented.

hugr-core/src/hugr/persistent.rs

cqc-alec · 2025-05-01T09:43:56Z

hugr-core/src/hugr/persistent.rs

+        for (parent, new_invalid_nodes) in new_invalid_nodes {
+            let invalidation_set = self.deleted_nodes(parent).collect();
+            if let Some(&node) = new_invalid_nodes.intersection(&invalidation_set).next() {
+                return Err(InvalidCommit::IncompatibleHistory(parent, node));


Would like to see a test for this.

hugr-core/src/hugr/persistent.rs

cqc-alec · 2025-05-01T10:15:44Z

hugr-core/src/hugr/persistent.rs

+    }
+}
+
+/// A Hugr-like object that supports persistent mutation.


I think "supports persistent mutation" is a rather odd way to describe it: maybe "... that includes its mutation history"? I'm still a bit doubtful about the name, though I don't have a great alternative. Would something like HugrRecord or HugrHistoryGraph be workable? They sound less "Hugr-like" though. Hmm ... perhaps PersistentHugr is best after all.

Agreed, "persistent mutation" is an awkward phrasing. I like and have adopted your suggested phrasing.

That being said, I do like the PersistentHugr name. I think using the adjective "persistent" is correct and helpful in this context, referring to an established pattern of functional programming. I'm open to other suggestions though.

lmondada and others added 2 commits April 8, 2025 16:24

feat!: Split Rewrite trait into VerifyPatch and ApplyPatch

7ad09f5

Merge branch 'main' into feat/rewrite-trait

eda21fa

lmondada changed the base branch from main to feat/rewrite-trait April 15, 2025 10:48

lmondada force-pushed the feat/persistenthugr branch from 44c3fe9 to 5780cda Compare April 15, 2025 10:49

lmondada requested a review from aborgna-q April 15, 2025 10:52

This was referenced Apr 15, 2025

feat: Add CircuitDiff CQCL/tket2#773

Closed

feat: Add CircuitHistory CQCL/tket2#778

Closed

feat!: Expand SimpleReplacement::ApplyResult type

553350c

lmondada force-pushed the feat/persistenthugr branch from 5780cda to 6659c40 Compare April 17, 2025 13:14

lmondada marked this pull request as ready for review April 17, 2025 13:17

lmondada requested a review from a team as a code owner April 17, 2025 13:17

feat: Add PersistentHugr

c480927

lmondada force-pushed the feat/persistenthugr branch from 6659c40 to c480927 Compare April 17, 2025 13:23

Base automatically changed from feat/rewrite-trait to release-rs-v0.16.0 April 29, 2025 13:20

lmondada added 4 commits April 29, 2025 15:32

Merge remote-tracking branch 'origin/release-rs-v0.16.0' into feat/pe…

9dd32a2

…rsistenthugr

rename Patch to Commit

154cd00

Merge branch 'release-rs-v0.16.0' into feat/persistenthugr

a5eb655

remove unwanted changes

aa7d5cb

lmondada force-pushed the feat/persistenthugr branch from 7fd00f3 to aa7d5cb Compare April 29, 2025 14:49

cargo clippy

4b95a1c

lmondada requested review from cqc-alec and removed request for aborgna-q April 29, 2025 15:06

fix docs link

fd7662d

cqc-alec reviewed May 1, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add PersistentHugr #2080

feat: Add PersistentHugr #2080

lmondada commented Apr 15, 2025 •

edited

Loading

lmondada commented Apr 17, 2025

codecov bot commented Apr 29, 2025 •

edited

Loading

cqc-alec left a comment

cqc-alec Apr 30, 2025

lmondada May 3, 2025

cqc-alec Apr 30, 2025

lmondada May 3, 2025

cqc-alec Apr 30, 2025

lmondada May 3, 2025

cqc-alec Apr 30, 2025

lmondada May 3, 2025

cqc-alec Apr 30, 2025

lmondada May 3, 2025

lmondada May 3, 2025

cqc-alec May 1, 2025

cqc-alec May 1, 2025

lmondada May 3, 2025

feat: Add PersistentHugr #2080

Are you sure you want to change the base?

feat: Add PersistentHugr #2080

Conversation

lmondada commented Apr 15, 2025 • edited Loading

lmondada commented Apr 17, 2025

codecov bot commented Apr 29, 2025 • edited Loading

Codecov Report

cqc-alec left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lmondada commented Apr 15, 2025 •

edited

Loading

codecov bot commented Apr 29, 2025 •

edited

Loading