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

Jump to bottom

feat: Store inout flags in FunctionType #315

Merged
merged 2 commits into from
Jul 25, 2024
Merged

feat: Store inout flags in FunctionType #315

merged 2 commits into from
Jul 25, 2024

Conversation

mark-koch
Copy link
Collaborator

@mark-koch mark-koch commented Jul 24, 2024 •
edited
Loading

Adds a new InputFlags enum that is paired up with each input in FunctionType. See #311 for context.

Closes #313

@mark-koch mark-koch requested a review from a team as a code owner July 24, 2024 11:14
@mark-koch mark-koch requested review from ss2165 and removed request for a team July 24, 2024 11:14
@mark-koch mark-koch mentioned this pull request Jul 24, 2024
Merged
ss2165
ss2165 reviewed Jul 24, 2024
View reviewed changes
Copy link
Member

@ss2165 ss2165 left a comment

Choose a reason for hiding this comment

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

the number of tuple unpackings is a bit unsatisfying, consider making a new dataclass holding type and flag

@mark-koch
Copy link
Collaborator Author

the number of tuple unpackings is a bit unsatisfying, consider making a new dataclass holding type and flag

I added the dataclass as suggested. It makes constructing FunctionTypes more verbose, but iterating over the inputs nicer. Do you prefer it this way?

@mark-koch mark-koch requested a review from ss2165 July 25, 2024 08:34
@mark-koch mark-koch merged commit 4010938 into feat/inout Jul 25, 2024
@mark-koch mark-koch deleted the inout/flags branch July 25, 2024 09:19
github-merge-queue bot pushed a commit that referenced this pull request Aug 22, 2024
@mark-koch
feat: Inout arguments (#311)
060649b 
This is the dev branch for the inout argument feature (tracked by #282).

The idea is to allow explicit `@inout` annotations on function arguments
that "give back" the passed value after the function returns:

```python
@guppy
def foo(q: qubit @inout) -> None: ...

@guppy
def bar(q1: qubit @inout, q2: qubit @inout) -> bool: ...

@guppy
def main() -> None:
   q1, q2 = qubit(), qubit()
   foo(q1)          # Desugars to `q1 = foo(q1)`
   x = bar(q1, q2)  # Desugars to `q1, q2, x = bar(q1, q2)`
   y = bar(q1, q1)  # Error: Linearity violation, q1 used twice
```

To enable this, we need to enforce that `@inout` arguments are not moved
in the body of the function (apart from passing them in another `@inout`
position). This means that the argument will always be bound to the same
name and never aliased which allows us to desugar `@inout` functions
like

```python
@guppy
def bar(q1: qubit, q2: qubit) -> bool:
   [body]
   return [expr]
```

into

```python
@guppy
def bar(q1: qubit, q2: qubit) -> tuple[qubit, qubit, bool]:
   [body]
   return q1, q2, [expr]  # Linearity checker needs to ensure that q1, q2 are unused
```

Note that we only allow `@inout` annotations on linear types, since they
would be useless for classical ones (unless we also implement an
ownership system for classical values). Supporting them would make the
checking logic more complicated without providing any meaningful
benefit.

Tracked PRs:
* #315
* #316
* #349
* #344
* #321
* #331
* #350
* #339 
* #340
* #351
@hugrbot hugrbot mentioned this pull request Aug 22, 2024
Merged
github-merge-queue bot pushed a commit that referenced this pull request Sep 11, 2024
@hugrbot
chore(main): release 0.10.0 (#377)
4309059 
🤖 I have created a release *beep* *boop*
---


## [0.10.0](v0.9.0...v0.10.0)
(2024-09-11)


### ⚠ BREAKING CHANGES

* Bumped the `hugr` dependency to `0.8.0`
* `GuppyModule.load` no longer loads the content of modules but instead
just brings the name of the module into scope. Use
`GuppyModule.load_all` to get the old behaviour.
* Removed `guppylang.hugr_builder.hugr.Hugr`, compiling a module returns
a `hugr.Package` instead.

### Features

* Add `__version__` field to guppylang
([#473](#473))
([b996c62](b996c62))
* Add angle type ([#449](#449))
([12e41e0](12e41e0))
* Add array literals
([#446](#446))
([a255c02](a255c02))
* Add equality test for booleans
([#394](#394))
([dd702ce](dd702ce)),
closes [#363](#363)
* Add pi constant ([#451](#451))
([9d35a78](9d35a78))
* Add qualified imports and make them the default
([#443](#443))
([553ec51](553ec51))
* Allow calling of methods
([#440](#440))
([5a59da3](5a59da3))
* Allow imports of function definitions and aliased imports
([#432](#432))
([e23b666](e23b666))
* Array indexing ([#415](#415))
([2199b48](2199b48)),
closes [#421](#421)
[#422](#422)
[#447](#447)
* Inout arguments ([#311](#311))
([060649b](060649b)),
closes [#315](#315)
[#316](#316)
[#349](#349)
[#344](#344)
[#321](#321)
[#331](#331)
[#350](#350)
[#340](#340)
[#351](#351)
* range() with single-argument
([#452](#452))
([d05f369](d05f369))
* Skip checking of redefined functions
([#457](#457))
([7f9ad32](7f9ad32))
* Support `nat`/`int` ↔ `bool` cast operations
([#459](#459))
([3b778c3](3b778c3))
* Use `hugr-cli` for validation
([#455](#455))
([1d0667b](1d0667b))
* Use cell name instead of file for notebook errors
([#382](#382))
([d542601](d542601))
* Use the hugr builder
([536abf9](536abf9))


### Bug Fixes

* Fix and update demo notebook
([#376](#376))
([23b2a15](23b2a15))
* Fix linearity checking bug
([#441](#441))
([0b8ea21](0b8ea21))
* Fix struct definitions in notebooks
([#374](#374))
([b009465](b009465))


### Documentation

* Update readme, `cargo build` instead of `--extra validation`
([#471](#471))
([c2a4c86](c2a4c86))


### Miscellaneous Chores

* Update hugr to `0.8.0`
([#454](#454))
([b02e0d0](b02e0d0))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
@hugrbot hugrbot mentioned this pull request Oct 21, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ss2165 ss2165 ss2165 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mark-koch @ss2165