feat: add MonomorphizePass and deprecate monomorphize #1809

ss2165 · 2024-12-18T11:03:02Z

No description provided.

codecov · 2024-12-18T11:18:27Z

Codecov Report

Attention: Patch coverage is 76.08696% with 11 lines in your changes missing coverage. Please review.

Project coverage is 86.64%. Comparing base (e065d70) to head (5dc24c1).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
hugr-passes/src/monomorphize.rs	76.08%	7 Missing and 4 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1809      +/-   ##
==========================================
- Coverage   86.66%   86.64%   -0.03%     
==========================================
  Files         191      191              
  Lines       34692    34713      +21     
  Branches    31549    31570      +21     
==========================================
+ Hits        30067    30077      +10     
- Misses       2927     2936       +9     
- Partials     1698     1700       +2

Flag	Coverage Δ
python	`92.49% <ø> (ø)`
rust	`86.06% <76.08%> (-0.03%)`	⬇️

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.

hugr-passes/src/monomorphize.rs

doug-q · 2024-12-18T12:23:06Z

hugr-passes/src/lib.rs

+pub use monomorphize::monomorphize;
+pub use monomorphize::{remove_polyfuncs, MonomorphizePass};


I don't understand why remove_polyfuncs is treated any differently to monomorphize here.
Please export MonomorphizeError

doug-q · 2024-12-18T12:35:45Z

hugr-passes/src/monomorphize.rs

    #[cfg(debug_assertions)]
    validate(&h);


Suggested change

#[cfg(debug_assertions)]

validate(&h);

kill these?

doug-q · 2024-12-18T12:37:25Z

hugr-passes/src/monomorphize.rs

+    h
+}
+
+fn monomorphize_ref(h: &mut impl HugrMut) {


I do not like the name. Is the plan to rename this in the next breaking release, and to add a deprecated alias monomorphize_ref? If so, could you add a TODO comment?
Similar for remove_polyfuncs_ref

this is a private function so we can rename to monomorphize when we remove the public one, will add comment

Co-authored-by: Douglas Wilson <[email protected]>

acl-cqc · 2024-12-18T12:57:42Z

hugr-passes/src/lib.rs

+// TODO: Deprecated re-export. Remove on a breaking release.
+#[deprecated(
+    since = "0.14.1",
+    note = "Use `hugr::algorithms::MonomorphizePass` instead."


Where is hugr::algorithms ?

hugr/hugr/src/lib.rs

Lines 134 to 135 in 5dc24c1

pub use hugr_passes as algorithms;

## 🤖 New release * `hugr`: 0.14.0 -> 0.14.1 (✓ API compatible changes) * `hugr-core`: 0.14.0 -> 0.14.1 (✓ API compatible changes) * `hugr-model`: 0.15.0 -> 0.16.0 (⚠️ API breaking changes) * `hugr-llvm`: 0.14.0 -> 0.14.1 (✓ API compatible changes) * `hugr-passes`: 0.14.0 -> 0.14.1 (✓ API compatible changes) * `hugr-cli`: 0.14.0 -> 0.14.1 (✓ API compatible changes) ### ⚠️ `hugr-model` breaking changes ``` --- failure constructible_struct_adds_field: externally-constructible struct adds field --- Description: A pub struct constructible with a struct literal has a new pub field. Existing struct literals must be updated to include the new field. ref: https://doc.rust-lang.org/reference/expressions/struct-expr.html impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.37.0/src/lints/constructible_struct_adds_field.ron Failed in: field Region.scope in /tmp/.tmpN5f4vM/hugr/hugr-model/src/v0/mod.rs:414 field LinkId.1 in /tmp/.tmpN5f4vM/hugr/hugr-model/src/v0/mod.rs:162 --- failure enum_missing: pub enum removed or renamed --- Description: A publicly-visible enum cannot be imported by its prior path. A `pub use` may have been removed, or the enum itself may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.37.0/src/lints/enum_missing.ron Failed in: enum hugr_model::v0::GlobalRef, previously in file /tmp/.tmp2gotdW/hugr-model/src/v0/mod.rs:456 enum hugr_model::v0::LocalRef, previously in file /tmp/.tmp2gotdW/hugr-model/src/v0/mod.rs:476 enum hugr_model::v0::LinkRef, previously in file /tmp/.tmp2gotdW/hugr-model/src/v0/mod.rs:494 --- failure enum_struct_variant_field_added: pub enum struct variant field added --- Description: An enum's exhaustive struct variant has a new field, which has to be included when constructing or matching on this variant. ref: https://doc.rust-lang.org/reference/attributes/type_system.html#the-non_exhaustive-attribute impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.37.0/src/lints/enum_struct_variant_field_added.ron Failed in: field symbol of variant Term::Apply in /tmp/.tmpN5f4vM/hugr/hugr-model/src/v0/mod.rs:544 field symbol of variant Term::ApplyFull in /tmp/.tmpN5f4vM/hugr/hugr-model/src/v0/mod.rs:557 --- failure enum_struct_variant_field_missing: pub enum struct variant's field removed or renamed --- Description: A publicly-visible enum has a struct variant whose field is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.37.0/src/lints/enum_struct_variant_field_missing.ron Failed in: field global of variant Term::Apply, previously in file /tmp/.tmp2gotdW/hugr-model/src/v0/mod.rs:544 field global of variant Term::ApplyFull, previously in file /tmp/.tmp2gotdW/hugr-model/src/v0/mod.rs:557 --- failure enum_variant_added: enum variant added on exhaustive enum --- Description: A publicly-visible enum without #[non_exhaustive] has a new variant. ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.37.0/src/lints/enum_variant_added.ron Failed in: variant ModelError:InvalidVar in /tmp/.tmpN5f4vM/hugr/hugr-model/src/v0/mod.rs:723 variant ModelError:InvalidSymbol in /tmp/.tmpN5f4vM/hugr/hugr-model/src/v0/mod.rs:726 variant Operation:Import in /tmp/.tmpN5f4vM/hugr/hugr-model/src/v0/mod.rs:374 --- failure enum_variant_missing: pub enum variant removed or renamed --- Description: A publicly-visible enum has at least one variant that is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.37.0/src/lints/enum_variant_missing.ron Failed in: variant ModelError::InvalidLocal, previously in file /tmp/.tmp2gotdW/hugr-model/src/v0/mod.rs:723 variant ModelError::InvalidGlobal, previously in file /tmp/.tmp2gotdW/hugr-model/src/v0/mod.rs:727 --- failure inherent_method_missing: pub method removed or renamed --- Description: A publicly-visible method or associated fn is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.37.0/src/lints/inherent_method_missing.ron Failed in: LinkId::new, previously in file /tmp/.tmp2gotdW/hugr-model/src/v0/mod.rs:140 LinkId::index, previously in file /tmp/.tmp2gotdW/hugr-model/src/v0/mod.rs:140 LinkId::unwrap_slice, previously in file /tmp/.tmp2gotdW/hugr-model/src/v0/mod.rs:140 LinkId::wrap_slice, previously in file /tmp/.tmp2gotdW/hugr-model/src/v0/mod.rs:140 --- failure struct_repr_transparent_removed: struct repr(transparent) removed --- Description: repr(transparent) was removed from a struct whose layout was part of the public ABI. This can cause its memory layout to change, breaking FFI use cases. ref: https://doc.rust-lang.org/cargo/reference/semver.html#repr-transparent-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.37.0/src/lints/struct_repr_transparent_removed.ron Failed in: struct LinkId in /tmp/.tmpN5f4vM/hugr/hugr-model/src/v0/mod.rs:162 ``` <details><summary>Changelog</summary> ## `hugr` <blockquote> ## [0.14.1](hugr-v0.14.0...hugr-v0.14.1) - 2024-12-18 ### Bug Fixes - Constant folding now tolerates root nodes without input/output nodes (#1799) - `Call` ops not tracking their parameter extensions (#1805) ### New Features - add MonomorphizePass and deprecate monomorphize (#1809) - Lower LoadNat to LLVM (#1801) - Cleanup `Display` of types and arguments (#1802) - add ArrayValue to python, rust and lowering (#1773) - Scoping rules and utilities for symbols, links and variables (#1754) </blockquote> ## `hugr-core` <blockquote> ## [0.14.1](hugr-core-v0.14.0...hugr-core-v0.14.1) - 2024-12-18 ### Bug Fixes - `Call` ops not tracking their parameter extensions (#1805) ### New Features - Lower LoadNat to LLVM (#1801) - Cleanup `Display` of types and arguments (#1802) - add ArrayValue to python, rust and lowering (#1773) - Scoping rules and utilities for symbols, links and variables (#1754) </blockquote> ## `hugr-model` <blockquote> ## [0.16.0](hugr-model-v0.15.0...hugr-model-v0.16.0) - 2024-12-18 ### New Features - Scoping rules and utilities for symbols, links and variables (#1754) </blockquote> ## `hugr-llvm` <blockquote> ## [0.14.1](hugr-llvm-v0.14.0...hugr-llvm-v0.14.1) - 2024-12-18 ### Bug Fixes - Add LLVM lowering for `logic.Not` (#1812) ### New Features - Lower LoadNat to LLVM (#1801) - add ArrayValue to python, rust and lowering (#1773) </blockquote> ## `hugr-passes` <blockquote> ## [0.14.1](hugr-passes-v0.14.0...hugr-passes-v0.14.1) - 2024-12-18 ### Bug Fixes - Constant folding now tolerates root nodes without input/output nodes (#1799) ### New Features - Cleanup `Display` of types and arguments (#1802) - add MonomorphizePass and deprecate monomorphize (#1809) </blockquote> ## `hugr-cli` <blockquote> ## [0.14.1](hugr-cli-v0.14.0...hugr-cli-v0.14.1) - 2024-12-18 ### New Features - Print `hugr-cli`'s correct version when using '--version' (#1790) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/).

ss2165 requested a review from a team as a code owner December 18, 2024 11:03

ss2165 requested review from zrho and doug-q and removed request for zrho December 18, 2024 11:03

ss2165 added 4 commits December 18, 2024 12:34

refactor: add reference taking monomorphization functions

ebd0bc3

feat: add MonomorphizePass and deprecate monomorphize

d696034

drive-by: appease typos

f61ef78

run tests with validation

4b1031f

ss2165 force-pushed the ss/mono-pass branch from 3cc0994 to 4b1031f Compare December 18, 2024 12:34

doug-q reviewed Dec 18, 2024

View reviewed changes

Update hugr-passes/src/monomorphize.rs

f5ca72e

Co-authored-by: Douglas Wilson <[email protected]>

doug-q approved these changes Dec 18, 2024

View reviewed changes

ss2165 force-pushed the ss/mono-pass branch from fc8c3a2 to 757b2b0 Compare December 18, 2024 12:44

review comments

112b28d

ss2165 force-pushed the ss/mono-pass branch from 757b2b0 to 112b28d Compare December 18, 2024 12:45

ss2165 enabled auto-merge December 18, 2024 12:45

undo docs change

5dc24c1

ss2165 added this pull request to the merge queue Dec 18, 2024

acl-cqc reviewed Dec 18, 2024

View reviewed changes

Merged via the queue into main with commit 7ee173c Dec 18, 2024
23 of 24 checks passed

ss2165 deleted the ss/mono-pass branch December 18, 2024 12:58

hugrbot mentioned this pull request Dec 18, 2024

chore: release #1794

Merged

hugrbot mentioned this pull request Dec 19, 2024

chore: release #1823

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add MonomorphizePass and deprecate monomorphize #1809

feat: add MonomorphizePass and deprecate monomorphize #1809

ss2165 commented Dec 18, 2024

codecov bot commented Dec 18, 2024 •

edited

Loading

doug-q Dec 18, 2024

doug-q Dec 18, 2024

doug-q Dec 18, 2024

ss2165 Dec 18, 2024

acl-cqc Dec 18, 2024

ss2165 Dec 18, 2024

acl-cqc Dec 18, 2024

		pub use monomorphize::monomorphize;
		pub use monomorphize::{remove_polyfuncs, MonomorphizePass};

feat: add MonomorphizePass and deprecate monomorphize #1809

feat: add MonomorphizePass and deprecate monomorphize #1809

Conversation

ss2165 commented Dec 18, 2024

codecov bot commented Dec 18, 2024 • edited Loading

Codecov Report

doug-q Dec 18, 2024

Choose a reason for hiding this comment

doug-q Dec 18, 2024

Choose a reason for hiding this comment

doug-q Dec 18, 2024

Choose a reason for hiding this comment

ss2165 Dec 18, 2024

Choose a reason for hiding this comment

acl-cqc Dec 18, 2024

Choose a reason for hiding this comment

ss2165 Dec 18, 2024

Choose a reason for hiding this comment

acl-cqc Dec 18, 2024

Choose a reason for hiding this comment

codecov bot commented Dec 18, 2024 •

edited

Loading