Skip to content

feat!: Add insert_region to HugrMut #2463

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
aborgna-q merged 4 commits into from
Jul 23, 2025
Merged

feat!: Add insert_region to HugrMut #2463

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f27b838
Add `insert_region` to HugrMut
aborgna-q Jul 23, 2025
042298c
InsertionResult docs
aborgna-q Jul 23, 2025
415fbae
Also add insert_region for build traits
aborgna-q Jul 23, 2025
910fcca
Review comments
aborgna-q Jul 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
44 changes: 29 additions & 15 deletions hugr-core/src/hugr/hugrmut.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,22 @@ pub trait HugrMut: HugrMutInternals {
/// # Panics
///
/// If the root node is not in the graph.
fn insert_hugr(&mut self, root: Self::Node, other: Hugr) -> InsertionResult<Node, Self::Node>;
fn insert_hugr(&mut self, root: Self::Node, other: Hugr) -> InsertionResult<Node, Self::Node> {
let region = other.entrypoint();
Self::insert_region(self, root, other, region)
}

/// Insert a sub-region of another hugr into this one, under a given parent node.
///
/// # Panics
///
/// If the root node is not in the graph.
Copy link
Contributor

@mark-koch mark-koch Jul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"root" instead of "parent"?

Copy link
Contributor

@mark-koch mark-koch Jul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I presume we also panic if region is not in other?

fn insert_region(
&mut self,
root: Self::Node,
other: Hugr,
region: Node,
) -> InsertionResult<Node, Self::Node>;

/// Copy another hugr into this one, under a given parent node.
///
Expand Down Expand Up @@ -247,15 +262,17 @@ pub trait HugrMut: HugrMutInternals {
ExtensionRegistry: Extend<Reg>;
}

/// Records the result of inserting a Hugr or view
/// via [`HugrMut::insert_hugr`] or [`HugrMut::insert_from_view`].
/// Records the result of inserting a Hugr or view via [`HugrMut::insert_hugr`],
/// [`HugrMut::insert_from_view`], or [`HugrMut::insert_region`].
///
/// Contains a map from the nodes in the source HUGR to the nodes in the
/// target HUGR, using their respective `Node` types.
/// Contains a map from the nodes in the source HUGR to the nodes in the target
/// HUGR, using their respective `Node` types.
pub struct InsertionResult<SourceN = Node, TargetN = Node> {
/// The node, after insertion, that was the entrypoint of the inserted Hugr.
/// The node, after insertion, that was the root of the inserted Hugr.
///
/// That is, the value in [`InsertionResult::node_map`] under the key that was the [`HugrView::entrypoint`].
/// That is, the value in [`InsertionResult::node_map`] under the key that
/// was the the `region` passed to [`HugrMut::insert_region`] or the
/// [`HugrView::entrypoint`] in the other cases.
pub inserted_entrypoint: TargetN,
/// Map from nodes in the Hugr/view that was inserted, to their new
/// positions in the Hugr into which said was inserted.
Expand Down Expand Up @@ -394,17 +411,14 @@ impl HugrMut for Hugr {
(src_port, dst_port)
}

fn insert_hugr(
fn insert_region(
&mut self,
root: Self::Node,
mut other: Hugr,
region: Node,
) -> InsertionResult<Node, Self::Node> {
let node_map = insert_hugr_internal(self, &other, other.entry_descendants(), |&n| {
if n == other.entrypoint() {
Some(root)
} else {
None
}
let node_map = insert_hugr_internal(self, &other, other.descendants(region), |&n| {
if n == region { Some(root) } else { None }
});
// Merge the extension sets.
self.extensions.extend(other.extensions());
Expand All @@ -420,7 +434,7 @@ impl HugrMut for Hugr {
self.metadata.set(new_node_pg, meta);
}
InsertionResult {
inserted_entrypoint: node_map[&other.entrypoint()],
inserted_entrypoint: node_map[&region],
node_map,
}
}
Expand Down
1 change: 1 addition & 0 deletions hugr-core/src/hugr/views/impls.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ macro_rules! hugr_mut_methods {
fn disconnect(&mut self, node: Self::Node, port: impl Into<crate::Port>);
fn add_other_edge(&mut self, src: Self::Node, dst: Self::Node) -> (crate::OutgoingPort, crate::IncomingPort);
fn insert_hugr(&mut self, root: Self::Node, other: crate::Hugr) -> crate::hugr::hugrmut::InsertionResult<crate::Node, Self::Node>;
fn insert_region(&mut self, root: Self::Node, other: crate::Hugr, region: crate::Node) -> crate::hugr::hugrmut::InsertionResult<crate::Node, Self::Node>;
fn insert_from_view<Other: crate::hugr::HugrView>(&mut self, root: Self::Node, other: &Other) -> crate::hugr::hugrmut::InsertionResult<Other::Node, Self::Node>;
fn insert_subgraph<Other: crate::hugr::HugrView>(&mut self, root: Self::Node, other: &Other, subgraph: &crate::hugr::views::SiblingSubgraph<Other::Node>) -> std::collections::HashMap<Other::Node, Self::Node>;
fn use_extension(&mut self, extension: impl Into<std::sync::Arc<crate::extension::Extension>>);
Expand Down
1 change: 1 addition & 0 deletions hugr-core/src/hugr/views/rerooted.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ impl<H: HugrMut> HugrMut for Rerooted<H> {
fn disconnect(&mut self, node: Self::Node, port: impl Into<crate::Port>);
fn add_other_edge(&mut self, src: Self::Node, dst: Self::Node) -> (crate::OutgoingPort, crate::IncomingPort);
fn insert_hugr(&mut self, root: Self::Node, other: crate::Hugr) -> crate::hugr::hugrmut::InsertionResult<crate::Node, Self::Node>;
fn insert_region(&mut self, root: Self::Node, other: crate::Hugr, region: crate::Node) -> crate::hugr::hugrmut::InsertionResult<crate::Node, Self::Node>;
fn insert_from_view<Other: crate::hugr::HugrView>(&mut self, root: Self::Node, other: &Other) -> crate::hugr::hugrmut::InsertionResult<Other::Node, Self::Node>;
fn insert_subgraph<Other: crate::hugr::HugrView>(&mut self, root: Self::Node, other: &Other, subgraph: &crate::hugr::views::SiblingSubgraph<Other::Node>) -> std::collections::HashMap<Other::Node, Self::Node>;
fn use_extension(&mut self, extension: impl Into<std::sync::Arc<crate::extension::Extension>>);
Expand Down
Loading