Skip to content
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

fix: extract_hugr not removing root node ports #1239

Merged
merged 2 commits into from
Jun 28, 2024
Merged

fix: extract_hugr not removing root node ports #1239

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5df394
fix: `extract_hugr` not removing root node ports
aborgna-q Jun 28, 2024
4635273
Add a flat test for SiblingGraph in addition to the DescendantGraph one
aborgna-q Jun 28, 2024
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
3 changes: 2 additions & 1 deletion hugr-core/src/hugr/views.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ use itertools::{Itertools, MapInto};
use portgraph::render::{DotFormat, MermaidFormat};
use portgraph::{multiportgraph, LinkView, PortView};

use super::internal::HugrInternals;
use super::internal::{HugrInternals, HugrMutInternals};
use super::{
Hugr, HugrError, HugrMut, NodeMetadata, NodeMetadataMap, ValidationError, DEFAULT_OPTYPE,
};
Expand Down Expand Up @@ -512,6 +512,7 @@ pub trait ExtractHugr: HugrView + Sized {
let old_root = hugr.root();
let new_root = hugr.insert_from_view(old_root, &self).new_root;
hugr.set_root(new_root);
hugr.set_num_ports(new_root, 0, 0);
Copy link
Collaborator

@doug-q doug-q Jun 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Shouldn't we add a test? make_module_hgr seems to provide a suitable case, the inner DFG (which has ports) should be extracted.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That's what the descendant graph test is doing. Only SiblingGraph and DescendantGraph run this code on extraction.

Copy link
Collaborator

Choose a reason for hiding this comment

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

The test you changed:

  • extracts a node that has no ports anyway
  • does not assert that the extracted Hugr has no ports

hugr.remove_node(old_root);
hugr
}
Expand Down
6 changes: 4 additions & 2 deletions hugr-core/src/hugr/views/sibling.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,7 @@ mod test {
use crate::builder::test::simple_dfg_hugr;
use crate::builder::{Container, Dataflow, DataflowSubContainer, HugrBuilder, ModuleBuilder};
use crate::extension::PRELUDE_REGISTRY;
use crate::hugr::views::DescendantsGraph;
use crate::ops::handle::{CfgID, DataflowParentID, DfgID, FuncID};
use crate::ops::{dataflow::IOTrait, Input, OpTag, Output};
use crate::ops::{OpTrait, OpType};
Expand Down Expand Up @@ -493,10 +494,11 @@ mod test {
fn extract_hugr() -> Result<(), Box<dyn std::error::Error>> {
let (hugr, def, _inner) = make_module_hgr()?;

let region: SiblingGraph = SiblingGraph::try_new(&hugr, def)?;
let region: DescendantsGraph = DescendantsGraph::try_new(&hugr, def)?;
let extracted = region.extract_hugr();
extracted.validate(&PRELUDE_REGISTRY)?;

let region: SiblingGraph = SiblingGraph::try_new(&hugr, def)?;
let region: DescendantsGraph = DescendantsGraph::try_new(&hugr, def)?;
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why are you changing to a DescendentsGraph? I think his test is supposed to be testing functionality of SiblingGraph.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The test hugr contains an inner DFG, so extracting just the SiblingGraph produced an invalid DFG node without children -.-

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think a good solution is to change it to extract the dfg, and assert that the root of the new hugr has no ports

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I guess I should have moved this test to descendants.rs. I'll do that, and add a flat case here for SiblingGraph


assert_eq!(region.node_count(), extracted.node_count());
assert_eq!(region.root_type(), extracted.root_type());
aborgna-q marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
Loading