Skip to content

refactor: tidies/readability improvements to PersistentHugr #2251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 26, 2025
Merged

refactor: tidies/readability improvements to PersistentHugr #2251

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
efb6664
Split partition_map into two iterations, avoiding use of IteratorNonE…
acl-cqc May 23, 2025
8be21ed
use filter
acl-cqc May 23, 2025
697618b
Filter out curr_repl_out first
acl-cqc May 23, 2025
6114c7e
Remove IteratorNonEmpty
acl-cqc May 23, 2025
7539155
Use is_some_and in is_input
acl-cqc May 23, 2025
b327dbb
Inline singly-called is_input
acl-cqc May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 18 additions & 50 deletions hugr-core/src/hugr/persistent.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,12 +473,6 @@ impl PersistentHugr {
loop {
let commit_id = out_node.0;

let is_input = || {
let Some(repl) = self.replacement(commit_id) else {
return false;
};
repl.get_replacement_io()[0] == out_node.1
};
if let Some(deleted_by) = self.find_deleting_commit(out_node) {
(out_node, out_port) = self
.state_space
Expand All @@ -494,7 +488,10 @@ impl PersistentHugr {
})
.expect("out_node is connected to output node (which is never deleted)")
};
} else if is_input() {
} else if self
.replacement(commit_id)
.is_some_and(|repl| repl.get_replacement_io()[0] == out_node.1)
{
// out_node is an input node
(out_node, out_port) = self
.as_state_space()
Expand Down Expand Up @@ -562,22 +559,22 @@ impl PersistentHugr {
// linked port in a parent commit), or
// (ii) they are deleted by a child commit and is not the same as the out_node
// (then there will be a linked port in a child commit)
let (is_linked_to_output, deleted_by_child): (IteratorNonEmpty, BTreeSet<_>) = hugr
let is_linked_to_output = curr_repl_out.is_some_and(|curr_repl_out| {
hugr.linked_inputs(out_node.1, out_port)
.any(|(in_node, _)| in_node == curr_repl_out)
});

let deleted_by_child: BTreeSet<_> = hugr
.linked_inputs(out_node.1, out_port)
.filter(|(in_node, _)| Some(in_node) != curr_repl_out.as_ref())
.filter_map(|(in_node, _)| {
if Some(in_node) == curr_repl_out {
// Flag that we have found a link to output
Some(Either::Left(()))
} else {
let other_deleted_by =
self.find_deleting_commit(PatchNode(commit_id, in_node))?;
// (out_node, out_port) -> (in_node, in_port) is a boundary edge
// into the child commit `other_deleted_by`
(Some(other_deleted_by) != out_deleted_by)
.then_some(Either::Right(other_deleted_by))
}
self.find_deleting_commit(PatchNode(commit_id, in_node))
.filter(|other_deleted_by|
// (out_node, out_port) -> (in_node, in_port) is a boundary edge
// into the child commit `other_deleted_by`
(Some(other_deleted_by) != out_deleted_by.as_ref()))
})
.partition_map(|x| x);
.collect();

// Convert an incoming port to the unique outgoing port that it is linked to
let to_outgoing_port = |(PatchNode(commit_id, in_node), in_port)| {
Expand All @@ -588,7 +585,7 @@ impl PersistentHugr {
(PatchNode(commit_id, out_node), out_port)
};

if is_linked_to_output.0 {
if is_linked_to_output {
// Traverse boundary to parent(s)
let new_ins = self
.as_state_space()
Expand Down Expand Up @@ -752,34 +749,5 @@ fn find_conflicting_node<'a>(
})
}

/// A wrapper around a boolean that implements `Extend<V>`. The boolean
/// is true if a non-empty iterator was appended to `self`.
#[derive(Debug, Copy, Clone, Default)]
struct IteratorNonEmpty(bool);

impl<V> Extend<V> for IteratorNonEmpty {
fn extend<T: IntoIterator<Item = V>>(&mut self, iter: T) {
self.0 |= iter.into_iter().next().is_some();
}
}

#[cfg(test)]
mod tests;

#[cfg(test)]
mod test_iterator_non_empty {
use super::IteratorNonEmpty;

use rstest::rstest;

#[rstest]
#[case(vec![])]
#[case(vec![1])]
#[case(vec![1, 2, 3])]
fn test_extend(#[case] input: Vec<i32>) {
let expected = !input.is_empty();
let mut res = IteratorNonEmpty::default();
res.extend(input);
assert_eq!(res.0, expected);
}
}
Loading