docs: Update spec wrt. polymorphism #791

acl-cqc · 2024-01-08T14:50:39Z

Move "Operation Extensionsibility" to after Type System (and up one level), rename to "Extension System"
Add Polymorphism section inside Type System: any Function type may be polymorphic
Clarify working of operations, including adding Appendix 3 with full details binary compute_signature
Add OpaqueOp as a dataflow node operation

fixes #790

acl-cqc · 2024-01-08T14:51:35Z

specification/hugr.md

+    node specifies any type arguments to the function in the node weight,
+    and the signature of the node (defined by its incoming and outgoing `Value` edges)
+    matches the (type-instantiated) function being called.
+  - `TypeApply`: has a `Value<Function>` input, whose type is polymorphic (i.e. declares some type parameters);


This is likely to go following resolution of #285, but I could put in more detail?

acl-cqc · 2024-01-08T14:52:01Z

specification/hugr.md

@@ -712,10 +718,222 @@ flowchart
    extension, taking a graph argument; and `run_circuit` will return the
    same way.

+### Extensible metadata


This is an unhelpful diff - this section has not changed

codecov · 2024-01-08T14:53:09Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b7c9c7c) 83.86% compared to head (58923cd) 83.86%.
Report is 2 commits behind head on main.

❗ Current head 58923cd differs from pull request most recent head 5bf9b74. Consider uploading reports for the commit 5bf9b74 to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #791   +/-   ##
=======================================
  Coverage   83.86%   83.86%           
=======================================
  Files          72       72           
  Lines       13867    13867           
  Branches    13867    13867           
=======================================
  Hits        11629    11629           
  Misses       1417     1417           
  Partials      821      821

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

specification/hugr.md

ss2165

looks good overall

specification/hugr.md

acl-cqc · 2024-01-09T18:25:28Z

Lord. I thought the merge would be straightforward but forgot that I'd moved a section and git seems to be handling that terribly. Really hoping I have done the merge right!....(EDIT: have now rebased this. Had to redo the first "move stuff" commit by hand on the new hugr.md from main, but the rest then reapplied straightforwardly)

specification/hugr.md

ss2165 · 2024-01-10T09:44:55Z

specification/hugr.md

+However, for OpDefs providing binary `compute_signature`,
+* each node will provide TypeArgs for *both* the binary function *and* the `Function` type that returns
+* the operation is only valid if `compute_signature` succeeds, and returns a `Function` type
+  into whose TypeParams the *remaining* TypeArgs (in the node) fit. Note that this means
+  the binary function may use the values of its TypeArgs---specifically including `List`, `Tuple` and
+  `Opaque`---to determine the structure of the returned `Function` type such that the latter's own TypeParams
+  depend upon the values of the TypeArgs passed into the binary.
+* the TypeArgs passed to `compute_signature` may *not* refer to any type variables declared by
+  ancestor nodes in the Hugr (specifically, may *not* use variables declared by the
+  enclosing FuncDefn) i.e. these must be static constants unaffected by substitution.


This is very thorough but feels like a lot of dense detail. Are we sure we need all of this here? Could dynamic computation of Function type be an appendix instead since we've hopefully made it a rare case?

Definitely not sure we need it all here - I think it's good to have it in the spec, but great idea to move it out, so in appendix 3

ss2165 · 2024-01-10T10:05:45Z

specification/hugr.md

+  the binary function may use the values of its TypeArgs---specifically including `List`, `Tuple` and
+  `Opaque`---to determine the structure of the returned `Function` type such that the latter's own TypeParams


Suggested change

the binary function may use the values of its TypeArgs---specifically including `List`, `Tuple` and

`Opaque`---to determine the structure of the returned `Function` type such that the latter's own TypeParams

the binary function may use the values of its TypeArgs--specifically including `List`, `Tuple` and

`Opaque`--to determine the structure of the returned `Function` type such that the latter's own TypeParams

?? Searching Google for "parenthetic dashes" confirms that these should be em dashes, which is --- ?

ss2165 · 2024-01-10T10:23:27Z

specification/hugr.md

-or the `compute_signature` implementation to compute the type of that operation node.
+### Extension Implementation
+
+To strike a balance then, every extension provides YAML (or equivalent Rust structs)


could refer explicitly to the "Declarative Format" section below

I put the note about Rust structs there too.

acl-cqc · 2024-01-15T12:09:49Z

Ok, moved details into appendix, and - hang on, how did we not have this already, did I miss something - added OpaqueOp as a dataflow op

ss2165

Great!

## 🤖 New release * `quantinuum-hugr`: 0.1.0 <details><summary>Changelog</summary> <blockquote> ## 0.1.0 (2024-01-15) ### Bug Fixes - Subgraph boundaries with copies ([#440](#440)) - [**breaking**] Use internal tag for SumType enum serialisation ([#462](#462)) - Check kind before unwrap in insert_identity ([#475](#475)) - Allow for variables to get solved in inference ([#478](#478)) - In IdentityInsertion add noop to correct parent ([#477](#477)) - Failing release tests ([#485](#485)) - [**breaking**] Serialise `Value`, `PrimValue`, and `TypeArg` with internal tags ([#496](#496)) - Serialise custom constants with internal tag ([#502](#502)) - [**breaking**] Reduce max int width in arithmetic extension to 64 ([#504](#504)) - HugrView::get_function_type ([#507](#507)) - TODO in resolve_extension_ops: copy across input_extensions ([#510](#510)) - Use given input extensions in `define_function` ([#524](#524)) - Lessen requirements for hugrs in outline_cfg ([#528](#528)) - Make unification logic less strict ([#538](#538)) - Simple replace incorrectly copying metadata ([#545](#545)) - Account for self-referencial constraints ([#551](#551)) - Consider shunted metas when comparing equality ([#555](#555)) - Join labels in issue workflow ([#563](#563)) - Comment out broken priority code ([#562](#562)) - Handling of issues with no priority label ([#573](#573)) - Don't insert temporary wires when extracting a subgraph ([#582](#582)) - Improve convexity checking and fix test ([#585](#585)) - Ignore input->output links in SiblingSubgraph::try_new_dataflow_subgraph ([#589](#589)) - Enforce covariance of SiblingMut::RootHandle ([#594](#594)) - Erratic stack overflow in infer.rs (live_var) ([#638](#638)) - Work harder in variable instantiation ([#591](#591)) - Actually add the error type to prelude ([#672](#672)) - Serialise dynamically computed opaqueOp signatures ([#690](#690)) - FuncDefns don't require that their extensions match their children ([#688](#688)) - Binary compute_signature returning a PolyFuncType with binders ([#710](#710)) - Use correct number of args for int ops ([#723](#723)) - [**breaking**] Add serde tag to TypeParam enum ([#722](#722)) - Allow widening and narrowing to same width. ([#735](#735)) - Case node should not have an external signature ([#749](#749)) - [**breaking**] Normalize input/output value/static/other ports in `OpType` ([#783](#783)) - No dataflow_signature for block types ([#792](#792)) - Ignore unsupported test in miri ([#794](#794)) - Include schema rather than read file ([#807](#807)) ### Documentation - Add operation constraint to quantum extension ([#543](#543)) - Coverage check section in DEVELOPMENT.md ([#648](#648)) - Remove "quantum extension" from HUGR spec. ([#694](#694)) - Improve crate-level docs, including example code. ([#698](#698)) - Spec cleanups and clarifications ([#742](#742)) - Spec clarifications ([#738](#738)) - Spec updates ([#741](#741)) - [spec] Remove references to causal cone and Order edges from Input ([#762](#762)) - Mention experimental inference in readme ([#800](#800)) - Collection of spec updates for 0.1 ([#801](#801)) - Add schema v0 ([#805](#805)) - Update spec wrt. polymorphism ([#791](#791)) ### Features - Derive things for builder structs ([#229](#229)) - Return a slice of types from the signature ([#238](#238)) - Move `dot_string` to `HugrView` ([#271](#271)) - [**breaking**] Change `TypeParam::USize` to `TypeParam::BoundedNat` and use in int extensions ([#445](#445)) - TKET2 compatibility requirements ([#450](#450)) - Split methods between `HugrMut` and `HugrMutInternals` ([#441](#441)) - Add `HugrView::node_connections` to get all links between nodes ([#460](#460)) - Location information in extension inference error ([#464](#464)) - Add T, Tdg, X gates ([#466](#466)) - [**breaking**] Add `ApplyResult` associated type to `Rewrite` ([#472](#472)) - Implement rewrite `IdentityInsertion` ([#474](#474)) - Instantiate inferred extensions ([#461](#461)) - Default DFG builders to open extension sets ([#473](#473)) - Some helper methods ([#482](#482)) - Extension inference for conditional nodes ([#465](#465)) - Add ConvexChecker ([#487](#487)) - Add clippy lint for mut calls in a debug_assert ([#488](#488)) - Default more builder methods to open extension sets ([#492](#492)) - Port is serializable ([#489](#489)) - More general portgraph references ([#494](#494)) - Add extension deltas to CFG ops ([#503](#503)) - Implement petgraph traits on Hugr ([#498](#498)) - Make extension delta a parameter of CFG builders ([#514](#514)) - [**breaking**] SiblingSubgraph does not borrow Hugr ([#515](#515)) - Validate TypeArgs to ExtensionOp ([#509](#509)) - Derive Debug & Clone for `ExtensionRegistry`. ([#530](#530)) - Const nodes are built with some extension requirements ([#527](#527)) - Some python errors and bindings ([#533](#533)) - Insert_hugr/insert_view return node map ([#535](#535)) - Add `SiblingSubgraph::try_from_nodes_with_checker` ([#547](#547)) - PortIndex trait for undirected port parameters ([#553](#553)) - Insert/extract subgraphs from a HugrView ([#552](#552)) - Add `new_array` operation to prelude ([#544](#544)) - Add a `DataflowParentID` node handle ([#559](#559)) - Make TypeEnum and it's contents public ([#558](#558)) - Optional direction check when querying a port index ([#566](#566)) - Extension inference for CFGs ([#529](#529)) - Better subgraph verification errors ([#587](#587)) - Compute affected nodes for `SimpleReplacement` ([#600](#600)) - Move `SimpleReplace::invalidation_set` to the `Rewrite` trait ([#602](#602)) - [**breaking**] Resolve extension ops (mutating Hugr) in (infer_and_->)update_validate ([#603](#603)) - Add accessors for node index and const values ([#605](#605)) - [**breaking**] Expose the value of ConstUsize ([#621](#621)) - Nicer debug and display for core types ([#628](#628)) - [**breaking**] Static checking of Port direction ([#614](#614)) - Builder and HugrMut add_op_xxx default to open extensions ([#622](#622)) - [**breaking**] Add panicking integer division ops ([#625](#625)) - Add hashable `Angle` type to Quantum extension ([#608](#608)) - [**breaking**] Remove "rotations" extension. ([#645](#645)) - Port.as_directed to match on either direction ([#647](#647)) - Impl GraphRef for PetgraphWrapper ([#651](#651)) - Provide+implement Replace API ([#613](#613)) - Require the node's metadata to always be a Map ([#661](#661)) - [**breaking**] Polymorphic function types (inc OpDefs) using dyn trait ([#630](#630)) - Make prelude error type public ([#669](#669)) - Shorthand for retrieving custom constants from `Const`, `Value` ([#679](#679)) - [**breaking**] HugrView API improvements ([#680](#680)) - Make FuncDecl/FuncDefn polymorphic ([#692](#692)) - [**breaking**] Simplify `SignatureFunc` and add custom arg validation. ([#706](#706)) - [**breaking**] Drop the `pyo3` feature ([#717](#717)) - [**breaking**] `OpEnum` trait for common opdef functionality ([#721](#721)) - MakeRegisteredOp trait for easier registration ([#726](#726)) - Getter for `PolyFuncType::body` ([#727](#727)) - `Into<OpType>` for custom ops ([#731](#731)) - Always require a signature in `OpaqueOp` ([#732](#732)) - Values (and hence Consts) know their extensions ([#733](#733)) - [**breaking**] Use ConvexChecker trait ([#740](#740)) - Custom const for ERROR_TYPE ([#756](#756)) - Implement RemoveConst and RemoveConstIgnore ([#757](#757)) - Constant folding implemented for core and float extension ([#769](#769)) - Constant folding for arithmetic conversion operations ([#720](#720)) - DataflowParent trait for getting inner signatures ([#782](#782)) - Constant folding for logic extension ([#793](#793)) - Constant folding for list operations ([#795](#795)) - Add panic op to prelude ([#802](#802)) - Const::from_bool function ([#803](#803)) ### HugrMut - Validate nodes for set_metadata/get_metadata_mut, too ([#531](#531)) ### HugrView - Validate nodes, and remove Base ([#523](#523)) ### Miscellaneous Tasks - [**breaking**] Update portgraph 0.10 and pyo3 0.20 ([#612](#612)) - [**breaking**] Hike MSRV to 1.75 ([#761](#761)) ### Performance - Use lazy static definittion for prelude registry ([#481](#481)) ### Refactor - Move `rewrite` inside `hugr`, `Rewrite` -> `Replace` implementing new 'Rewrite' trait ([#119](#119)) - Use an excluded upper bound instead of max log width. ([#451](#451)) - Add extension info to `Conditional` and `Case` ([#463](#463)) - `ExtensionSolution` only consists of input extensions ([#480](#480)) - Remove builder from more DFG tests ([#490](#490)) - Separate hierarchy views ([#500](#500)) - [**breaking**] Use named struct for float constants ([#505](#505)) - Allow NodeType::new to take any Into<Option<ExtensionSet>> ([#511](#511)) - Move apply_rewrite from Hugr to HugrMut ([#519](#519)) - Use SiblingSubgraph in SimpleReplacement ([#517](#517)) - CFG takes a FunctionType ([#532](#532)) - Remove check_custom_impl by inlining into check_custom ([#604](#604)) - Insert_subgraph just return HashMap, make InsertionResult new_root compulsory ([#609](#609)) - [**breaking**] Rename predicate to TupleSum/UnitSum ([#557](#557)) - Simplify infer.rs/report_mismatch using early return ([#615](#615)) - Move the core types to their own module ([#627](#627)) - Change &NodeType->&OpType conversion into op() accessor ([#623](#623)) - Infer.rs 'fn results' ([#631](#631)) - Be safe ([#637](#637)) - NodeType constructors, adding new_auto ([#635](#635)) - Constraint::Plus stores an ExtensionSet, which is a BTreeSet ([#636](#636)) - [**breaking**] Remove `SignatureDescription` ([#644](#644)) - [**breaking**] Remove add_op_<posn> by generalizing add_node_<posn> with "impl Into" ([#642](#642)) - Rename accidentally-changed Extension::add_node_xxx back to add_op ([#659](#659)) - [**breaking**] Remove quantum extension ([#670](#670)) - Use type schemes in extension definitions wherever possible ([#678](#678)) - [**breaking**] Flatten `Prim(Type/Value)` in to parent enum ([#685](#685)) - [**breaking**] Rename `new_linear()` to `new_endo()`. ([#697](#697)) - Replace NodeType::signature() with io_extensions() ([#700](#700)) - Validate ExtensionRegistry when built, not as we build it ([#701](#701)) - [**breaking**] One way to add_op to extension ([#704](#704)) - Remove Signature struct ([#714](#714)) - Use `MakeOpDef` for int_ops ([#724](#724)) - [**breaking**] Use enum op traits for floats + conversions ([#755](#755)) - Avoid dynamic dispatch for non-folding operations ([#770](#770)) - Simplify removeconstignore verify ([#768](#768)) - [**breaking**] Unwrap BasicBlock enum ([#781](#781)) - Make clear const folding only for leaf ops ([#785](#785)) - [**breaking**] `s/RemoveConstIgnore/RemoveLoadConstant` ([#789](#789)) - Put extension inference behind a feature gate ([#786](#786)) ### SerSimpleType - Use Vec not TypeRow ([#381](#381)) ### SimpleReplace+OutlineCfg - Use HugrMut methods rather than .hierarchy/.graph ([#280](#280)) ### Testing - Update inference test to not use DFG builder ([#550](#550)) - Strengthen "failing_sccs_test", rename to "sccs" as it's not failing! ([#660](#660)) - [**breaking**] Improve coverage in signature and validate ([#643](#643)) - Use insta snapshots to add dot_string coverage ([#682](#682)) - Miri ignore file-opening test ([#684](#684)) - Unify the serialisation tests ([#730](#730)) - Add schema validation to roundtrips ([#806](#806)) ### `ConstValue - :F64` and `OpaqueOp::new` ([#206](#206)) ### Cleanup - Remove outdated comment ([#536](#536)) ### Cosmetic - Format + remove stray TODO ([#444](#444)) ### Doc - Crate name as README title + add reexport ([#199](#199)) ### S/EdgeKind - :Const/EdgeKind::Static/ ([#201](#201)) ### Simple_replace.rs - Use HugrMut::remove_node, includes clearing op_types ([#242](#242)) ### Spec - Remove "Draft 3" from title of spec document. ([#590](#590)) - Rephrase confusing paragraph about TailLoop inputs/outputs ([#567](#567)) ### Src/ops/validate.rs - Common-up some type row calculations ([#254](#254)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). --------- Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Agustín Borgna <[email protected]>

acl-cqc added the spec Issues to do with the specification document(s) label Jan 8, 2024

acl-cqc commented Jan 8, 2024

View reviewed changes

acl-cqc force-pushed the spec/polymorphism branch from 1d79001 to aff7651 Compare January 8, 2024 14:55

acl-cqc commented Jan 8, 2024

View reviewed changes

specification/hugr.md Outdated Show resolved Hide resolved

acl-cqc commented Jan 8, 2024

View reviewed changes

specification/hugr.md Outdated Show resolved Hide resolved

acl-cqc commented Jan 8, 2024

View reviewed changes

specification/hugr.md Outdated Show resolved Hide resolved

acl-cqc force-pushed the spec/polymorphism branch from aff7651 to ebb046e Compare January 8, 2024 15:00

acl-cqc requested a review from ss2165 January 8, 2024 15:01

ss2165 reviewed Jan 8, 2024

View reviewed changes

specification/hugr.md Outdated Show resolved Hide resolved

specification/hugr.md Outdated Show resolved Hide resolved

specification/hugr.md Outdated Show resolved Hide resolved

specification/hugr.md Outdated Show resolved Hide resolved

ss2165 mentioned this pull request Jan 9, 2024

Rewrite extension section of spec to reflect current behaviour #745

Closed

acl-cqc mentioned this pull request Jan 9, 2024

docs: collection of spec updates for 0.1 #801

Merged

4 tasks

acl-cqc added 9 commits January 9, 2024 18:16

Move Operation Extensibility section

e81d110

Various pseudo-driveby tidies

4631114

Rewrite sections re. polymorphism

f46a758

Operation Extensibility -> Extension System, lots more on TypeDefs

6834c52

Update link in 'Extension Tracking' section

7c0f60c

Drop commented-out, written elsewhere now

7dd6386

Review comment (missing .)

009f77f

Mention Function 'delta'

0f2a032

Move + rewrite that 'notably' section

ec0be0f

acl-cqc requested a review from ss2165 January 9, 2024 18:25

acl-cqc force-pushed the spec/polymorphism branch from c3a790c to ec0be0f Compare January 9, 2024 18:27

acl-cqc commented Jan 10, 2024

View reviewed changes

specification/hugr.md Outdated Show resolved Hide resolved

acl-cqc commented Jan 10, 2024

View reviewed changes

specification/hugr.md Outdated Show resolved Hide resolved

acl-cqc commented Jan 10, 2024

View reviewed changes

specification/hugr.md Outdated Show resolved Hide resolved

ss2165 reviewed Jan 10, 2024

View reviewed changes

Move note about [Foo] syntax

15b12bd

acl-cqc added 5 commits January 15, 2024 11:41

Various clarifications/rewordings in section Polymorphism + on TypeApply

58923cd

Try restructuring binary-copute-sig details into a footnote

60f12b0

No, doesn't work, so move to appendix

6d0bb93

Move note about rust structs, link

6aa4e37

Add 'OpaqueOp' node type

5bf9b74

acl-cqc requested a review from ss2165 January 15, 2024 12:09

ss2165 approved these changes Jan 15, 2024

View reviewed changes

acl-cqc added this pull request to the merge queue Jan 15, 2024

Merged via the queue into main with commit d5e2cd5 Jan 15, 2024
9 checks passed

acl-cqc deleted the spec/polymorphism branch January 15, 2024 15:02

github-actions bot mentioned this pull request Jan 15, 2024

chore: release v0.1.0 #766

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Update spec wrt. polymorphism #791

docs: Update spec wrt. polymorphism #791

acl-cqc commented Jan 8, 2024 •

edited

Loading

acl-cqc Jan 8, 2024

acl-cqc Jan 8, 2024

codecov bot commented Jan 8, 2024 •

edited

Loading

ss2165 left a comment

acl-cqc commented Jan 9, 2024 •

edited

Loading

ss2165 Jan 10, 2024

acl-cqc Jan 15, 2024

ss2165 Jan 10, 2024

acl-cqc Jan 15, 2024

ss2165 Jan 10, 2024

acl-cqc Jan 15, 2024

acl-cqc commented Jan 15, 2024

ss2165 left a comment

		the binary function may use the values of its TypeArgs---specifically including `List`, `Tuple` and
		`Opaque`---to determine the structure of the returned `Function` type such that the latter's own TypeParams

docs: Update spec wrt. polymorphism #791

docs: Update spec wrt. polymorphism #791

Conversation

acl-cqc commented Jan 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jan 8, 2024 • edited Loading

Codecov Report

ss2165 left a comment

Choose a reason for hiding this comment

acl-cqc commented Jan 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

acl-cqc commented Jan 15, 2024

ss2165 left a comment

Choose a reason for hiding this comment

acl-cqc commented Jan 8, 2024 •

edited

Loading

codecov bot commented Jan 8, 2024 •

edited

Loading

acl-cqc commented Jan 9, 2024 •

edited

Loading