feat!: Extend LowerTypes pass to linearize by inserting copy/discard #2018

acl-cqc · 2025-03-21T16:24:03Z

Does not handle nonlocal edges. This is much more involved, not part of this PR. I note feat(hugr-passes)!: Add UnNonLocalPass #1912
handlers for arrays follow in feat: ReplaceTypes: handlers for array constants + linearization #2023

BREAKING CHANGE: OpReplacement renamed to NodeTemplate. Note this is not a breaking change if this PR goes in the same release as #1989 (which introduced OpReplacement)

… loops

…lmost all cases

…pes.rs

…d Const.

hugrbot · 2025-03-28T21:19:47Z

This PR contains breaking changes to the public Rust API.

cargo-semver-checks summary


--- 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.40.0/src/lints/enum_missing.ron

Failed in:
enum hugr_passes::replace_types::OpReplacement, previously in file /home/runner/work/hugr/hugr/BASELINE_BRANCH/hugr-passes/src/replace_types.rs:28

acl-cqc · 2025-03-28T21:36:43Z

@doug-q ok so with the OpReplacement -> NodeTemplate rename the pressure of time kicks in, but I think I've done most of the things you suggest (good comments, thank you!) - the only thing that remains is the errors: I kinda disagree with your point about builder errors, I think those are our mistakes, but I've noted in my replies a couple of things I would be happy to make into reported errors (easy ones, too!), what do you think?

EDIT: I've also remove the linearize_x methods from ReplaceTypes and just expose the Linearizer directly. This was better in terms of giving one place in which to concentrate docs; and in the future, one can imagine giving the linearizer a run method that, without replacing types, just checks every outport of every node. (I think this can come after #1895, given that validation before Linearizer will fail! But we can keep the idea that ReplaceTypes has its own Linearizer that it uses only on nodes that it has changed.)

acl-cqc · 2025-03-30T17:31:14Z

hugr-passes/src/replace_types/linearize.rs

+    ///   as part of an [NodeTemplate::CompoundOp].
+    ///
+    /// Note that [Self::register] takes precedence when the `src` types overlap.
+    pub fn register_parametric(


So perhaps that this one takes a callback, supporting arbitrary N, whereas register has only 0-ary discard and 2-ary copy, might be the bigger difference; both can be used for monomorphic types. It might be better to rename, thus

this one to register_callback or register_with_callback or even just register?

register maybe to register_binary / register_2way / register_(dup/copy)_discard / register_simple ??

I like register_simple/register_callback best, but do not feel strongly about it..

acl-cqc · 2025-03-31T18:54:35Z

Ok @doug-q fire away. I tried using &dyn Linearizer rather than the rather-odd-seeming-on-its-own CallbackHandler....yes dyn is inefficient but that seemed a lot cleaner...however it required making Linearizer object-safe and other changes (but you can see cc4fd68)

doug-q

Looks great, thanks Alan. I will fix CI.

## 🤖 New release * `hugr-model`: 0.18.1 -> 0.19.0 (⚠ API breaking changes) * `hugr-core`: 0.15.2 -> 0.15.3 ~(⚠ API breaking changes)~ * `hugr-llvm`: 0.15.2 -> 0.15.3 (✓ API compatible changes) * `hugr-passes`: 0.15.2 -> 0.15.3 (✓ API compatible changes) * `hugr`: 0.15.2 -> 0.15.3 (✓ API compatible changes) * `hugr-cli`: 0.15.2 -> 0.15.3 (✓ API compatible changes) ### ⚠ `hugr-model` breaking changes ```text --- 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.40.0/src/lints/enum_missing.ron Failed in: enum hugr_model::v0::table::ExtSetPart, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/table/mod.rs:352 --- 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.40.0/src/lints/enum_variant_added.ron Failed in: variant Term:Func in /tmp/.tmpIpZPlW/hugr/hugr-model/src/v0/table/mod.rs:341 --- 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.40.0/src/lints/enum_variant_missing.ron Failed in: variant Term::ExtSet, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/table/mod.rs:316 variant Term::ConstFunc, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/table/mod.rs:321 variant Term::ExtSet, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/ast/mod.rs:237 --- failure pub_module_level_const_missing: pub module-level const is missing --- Description: A public const is missing or renamed ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/pub_module_level_const_missing.ron Failed in: CORE_EXT_SET in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/mod.rs:177 ``` ### ⚠ `hugr-core` breaking changes (⚠️ ignored ⚠️ ) ```text --- 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.40.0/src/lints/enum_variant_added.ron Failed in: variant ImportError:OrderHint in /tmp/.tmpIpZPlW/hugr/hugr-core/src/import.rs:73 ``` <details><summary>Changelog</summary> ## `hugr-model` <blockquote> ## [0.19.0](hugr-model-v0.18.1...hugr-model-v0.19.0) - 2025-04-02 ### New Features - Python bindings for `hugr-model`. ([#1959](#1959)) - Remove extension sets from `hugr-model`. ([#2031](#2031)) - Packages in `hugr-model` and envelope support. ([#2026](#2026)) - Represent order edges in `hugr-model` as metadata. ([#2027](#2027)) </blockquote> ## `hugr-core` <blockquote> ## [0.16.0](hugr-core-v0.15.2...hugr-core-v0.16.0) - 2025-04-02 ### Documentation - Provide docs for array ops, fix bad doc for HugrView::poly_func_type ([#2021](#2021)) ### New Features - Expand SimpleReplacement API ([#1920](#1920)) - Python bindings for `hugr-model`. ([#1959](#1959)) - ReplaceTypes pass allows replacing extension types and ops ([#1989](#1989)) - Remove extension sets from `hugr-model`. ([#2031](#2031)) - Packages in `hugr-model` and envelope support. ([#2026](#2026)) - Represent order edges in `hugr-model` as metadata. ([#2027](#2027)) - add `build_expect_sum` to allow specific error messages ([#2032](#2032)) </blockquote> ## `hugr-llvm` <blockquote> ## [0.16.0](hugr-llvm-v0.15.2...hugr-llvm-v0.16.0) - 2025-04-02 ### New Features - *(hugr-llvm)* Add llvm codegen for `arithmetic.float.fpow` ([#2042](#2042)) - *(hugr-llvm)* Emit divmod and mod operations ([#2025](#2025)) </blockquote> ## `hugr-passes` <blockquote> ## [0.16.0](hugr-passes-v0.15.2...hugr-passes-v0.16.0) - 2025-04-02 ### New Features - ReplaceTypes pass allows replacing extension types and ops ([#1989](#1989)) - MakeTuple->UnpackTuple elision pass ([#2012](#2012)) - [**breaking**] Extend LowerTypes pass to linearize by inserting copy/discard ([#2018](#2018)) </blockquote> ## `hugr` <blockquote> ## [0.16.0](hugr-v0.15.2...hugr-v0.16.0) - 2025-04-02 ### Documentation - Provide docs for array ops, fix bad doc for HugrView::poly_func_type ([#2021](#2021)) ### New Features - MakeTuple->UnpackTuple elision pass ([#2012](#2012)) - [**breaking**] Extend LowerTypes pass to linearize by inserting copy/discard ([#2018](#2018)) - Expand SimpleReplacement API ([#1920](#1920)) - Python bindings for `hugr-model`. ([#1959](#1959)) - ReplaceTypes pass allows replacing extension types and ops ([#1989](#1989)) - Remove extension sets from `hugr-model`. ([#2031](#2031)) - Represent order edges in `hugr-model` as metadata. ([#2027](#2027)) - add `build_expect_sum` to allow specific error messages ([#2032](#2032)) - Packages in `hugr-model` and envelope support. ([#2026](#2026)) </blockquote> ## `hugr-cli` <blockquote> ## [0.16.0](hugr-cli-v0.15.2...hugr-cli-v0.16.0) - 2025-04-02 ### Documentation - Add usage info to hugr-cli's rustdocs ([#2044](#2044)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: Agustín Borgna <[email protected]>

acl-cqc added 30 commits March 17, 2025 19:14

Add TypeTransformer and (Sum/Function)Type(Arg/Row)::transform

937cd14

trait Transformable to common up all the 'let mut any_change = false'…

815536b

… loops

Transformable v2: implement for [E], works without iter_mut/etc. in a…

cc1e8f2

…lmost all cases

first test, fix CustomType bound caching

4888184

Second test, fix SumType caching

7002e4d

Make clippy happy

6cc7cea

Add HugrMut::optype_mut (v2, allow mutating root if RootHandle == Node)

d43784b

WIP add hugr-passes/src/lower_types.rs (w/ change_node, subst_ty)

422c496

Add def_arc

76ed391

change_node, change_type, and the rest

ed5b5dd

Use TypeTransformer framework, removing most type_stuff from lower_ty…

adcbbf6

…pes.rs

Add a load of copy/discard lowering stuff, OpReplacement

d84ae4e

OpHashWrapper

bfa52cf

Parametrized type support

b373571

remove copy_discard stuff

a8e613a

Assume less in OpReplacement::replace

24ed15c

parametrized ops

9153fcf

Comments, renaming, use const_fn

a89879c

Comment const_fn TODO

c78d88a

Test panics on unexpected argument - simpler, better

bf6a9a4

test functiontype

5ecd9e6

clippy that new test

d9a6d29

Merge remote-tracking branch 'origin/main' into acl/type_transform

83e798e

WIP setup for test

84fe82d

First test

6168353

read only makes sense for Copyables

fcb85a2

Extend test to Calls of polyfunc; comments, monomorphize first

0f9aa17

no, instantiate the calls with types being lowered

74c6775

Consts: HashMap keyed by either, add lower_ methods. Test TailLoop an…

00fd284

…d Const.

clippy, turn off type-complexity

9f02acf

fix dataflowparent doclink

221bf7d

acl-cqc changed the title ~~feat: Extend LowerTypes pass to linearize by inserting copy/discard~~ feat!: Extend LowerTypes pass to linearize by inserting copy/discard Mar 28, 2025

acl-cqc requested a review from doug-q March 28, 2025 21:34

acl-cqc added 3 commits March 30, 2025 08:49

Remove linearize() proxy methods, add linearizer() getter - docs a mess

f6312bc

docs+notes

5fe25c0

fix lists in docs

edd2126

acl-cqc commented Mar 30, 2025

View reviewed changes

acl-cqc added 3 commits March 31, 2025 19:46

Add Linearizer trait, rename to DelegatingLinearizer

5ea9763

Pass &dyn Linearizer - requires making object-safe

cc4fd68

No - revert - instead pass ref to new CallbackHandler struct

8a1ff0c

acl-cqc added 3 commits April 1, 2025 10:17

Add LinearizeError::WrongSignature

d5e4ac3

Remove NeedDiscard, rename NeedCopy

b259426

test, also check sig for register(CustTy, NodeTempl*2)

a14fafa

doug-q approved these changes Apr 2, 2025

View reviewed changes

doug-q and others added 3 commits April 2, 2025 08:11

lint

a4686d3

docs

1abf1b4

Rename register(=>_simple,_parametric=>_callback), docs

7e3efcc

acl-cqc enabled auto-merge April 2, 2025 09:19

acl-cqc added this pull request to the merge queue Apr 2, 2025

Merged via the queue into main with commit 9ad9e6d Apr 2, 2025
25 checks passed

acl-cqc deleted the acl/lower_types_linearize branch April 2, 2025 09:34

hugrbot mentioned this pull request Apr 2, 2025

chore: release #2051

Merged

This was referenced Apr 3, 2025

chore: release #2058

Closed

chore: release #2065

Closed

hugrbot mentioned this pull request Apr 15, 2025

chore: release v0.19.1 #2079

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: Extend LowerTypes pass to linearize by inserting copy/discard #2018

feat!: Extend LowerTypes pass to linearize by inserting copy/discard #2018

acl-cqc commented Mar 21, 2025 •

edited

Loading

hugrbot commented Mar 28, 2025 •

edited

Loading

acl-cqc commented Mar 28, 2025 •

edited

Loading

acl-cqc Mar 30, 2025 •

edited

Loading

doug-q Apr 2, 2025

acl-cqc Apr 2, 2025

acl-cqc commented Mar 31, 2025

doug-q left a comment

feat!: Extend LowerTypes pass to linearize by inserting copy/discard #2018

feat!: Extend LowerTypes pass to linearize by inserting copy/discard #2018

Conversation

acl-cqc commented Mar 21, 2025 • edited Loading

hugrbot commented Mar 28, 2025 • edited Loading

acl-cqc commented Mar 28, 2025 • edited Loading

acl-cqc Mar 30, 2025 • edited Loading

Choose a reason for hiding this comment

doug-q Apr 2, 2025

Choose a reason for hiding this comment

acl-cqc Apr 2, 2025

Choose a reason for hiding this comment

acl-cqc commented Mar 31, 2025

doug-q left a comment

Choose a reason for hiding this comment

acl-cqc commented Mar 21, 2025 •

edited

Loading

hugrbot commented Mar 28, 2025 •

edited

Loading

acl-cqc commented Mar 28, 2025 •

edited

Loading

acl-cqc Mar 30, 2025 •

edited

Loading