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.

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

feat: Update linearity checker to handle subscripts #421

Merged
merged 3 commits into from
Aug 30, 2024

Conversation

mark-koch
Copy link
Collaborator

Closes #417 and closes #252. See #415 for context.

@mark-koch mark-koch requested a review from a team as a code owner August 28, 2024 11:21
@mark-koch mark-koch requested review from aborgna-q and removed request for a team August 28, 2024 11:21
@codecov-commenter
Copy link

codecov-commenter commented Aug 28, 2024

Codecov Report

Attention: Patch coverage is 87.87879% with 4 lines in your changes missing coverage. Please review.

Project coverage is 92.48%. Comparing base (61997cb) to head (c6b1cb2).

Files with missing lines Patch % Lines
guppylang/checker/linearity_checker.py 87.87% 4 Missing ⚠️
Additional details and impacted files
@@               Coverage Diff               @@
##           feat/arrays     #421      +/-   ##
===============================================
+ Coverage        92.46%   92.48%   +0.01%     
===============================================
  Files               48       48              
  Lines             5232     5256      +24     
===============================================
+ Hits              4838     4861      +23     
- Misses             394      395       +1     

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

@mark-koch mark-koch mentioned this pull request Aug 28, 2024
Base automatically changed from array/checking to feat/arrays August 30, 2024 14:48
@mark-koch mark-koch merged commit ded9e1c into feat/arrays Aug 30, 2024
2 checks passed
@mark-koch mark-koch deleted the array/linearity branch August 30, 2024 15:59
github-merge-queue bot pushed a commit that referenced this pull request Sep 4, 2024
This is the feature branch for array indexing. Tracked by #253.

The goal is to allow array indexing in `@inout` positions that ignores
linearity constraints in the indices:

```python
qs: array[qubit, 42]
cx(qs[0], qs[1])  # Ok
cx(qs[0], qs[0])  # Compiles, but will panic at runtime
q = qs[0]  # Error: Indexing only allowed in inout position
```

This is achieved by lowering `array[qubit]` to `array[qubit | None]` and
making `array.__getitem__` and `array.__setitem__` swap in `None`
whenever a qubit is taken out or put back in. The functions
`array.__getitem__` and `array.__setitem__` take the array as `@inout`,
so it suffices to apply the following desugaring:

```python
cx(qs[expr1], qs[expr2])

# Desugars to
idx1 = expr1
idx2 = expr2
tmp1 = qs.__getitem__(idx1)
tmp2 = qs.__getitem__(idx2)
cx(tmp1, tmp2)
qs.__setitem__(tmp1, idx1)
qs.__setitem__(tmp2, idx2)
```

This also means that arrays containing structs might behave slightly
unexpectedly:

```python
@guppy.struct
class QubitPair:
    q1: qubit
    q2: qubit

ps: array[QubitPair, 42]
cx(ps[0].q1, ps[0].q2)  # Panics at runtime :(

# Since it desugars to
idx1 = 0
idx2 = 0
tmp1 = ps.__getitem__(idx1)
tmp2 = ps.__getitem__(idx2)  # Panic: Struct at index 0 has already been replaced with None
cx(tmp1.q1, tmp2.q2)
...
```

To solve this, we need to change the Hugr lowering of arrays to
structually replace any occurrence of `qubit` with `qubit | None`, i.e.
instead of doing `array[QubitPair | None]`, we would need to do
`array[tuple[qubit | None, qubit | None]]`. I'll leave this to a future
PR in case we are interested in that.

The following feature PRs target this branch:
* #420 
* #421
* #422
* #447
github-merge-queue bot pushed a commit that referenced this pull request Sep 11, 2024
🤖 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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants