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

docs: Clarify CustomConst::equal_consts #1396

Merged
merged 3 commits into from
Aug 6, 2024
Merged

docs: Clarify CustomConst::equal_consts #1396

merged 3 commits into from
Aug 6, 2024

Conversation

acl-cqc
Copy link
Contributor

@acl-cqc acl-cqc commented Aug 6, 2024

This is just explaining existing behaviour, but I think it's important to explain that we are not expecting the equivalent of Eq on a structure that could be just an f64....

This does constrain impls to be symmetric and transitive, but all current ones are, and I couldn't think of any... (indeed, "either Eq or always return false" would describe all current impls, and this is still significantly more permissive than that.)

@acl-cqc acl-cqc changed the title Comment re. CustomConst::equal_consts doc: Comment re. CustomConst::equal_consts Aug 6, 2024
@acl-cqc acl-cqc changed the title doc: Comment re. CustomConst::equal_consts docs: CustomConst::equal_consts Aug 6, 2024
@acl-cqc acl-cqc changed the title docs: CustomConst::equal_consts docs: Clarify CustomConst::equal_consts Aug 6, 2024
@acl-cqc acl-cqc requested a review from aborgna-q August 6, 2024 15:46
@acl-cqc acl-cqc marked this pull request as ready for review August 6, 2024 15:46
@acl-cqc acl-cqc requested a review from a team as a code owner August 6, 2024 15:46
Copy link

codecov bot commented Aug 6, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 87.64%. Comparing base (27db0f2) to head (225c9bd).

Files Patch % Lines
hugr-core/src/ops/constant/custom.rs 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1396   +/-   ##
=======================================
  Coverage   87.64%   87.64%           
=======================================
  Files         118      118           
  Lines       20347    20347           
  Branches    18035    18035           
=======================================
  Hits        17833    17833           
  Misses       1725     1725           
  Partials      789      789           
Flag Coverage Δ
python 91.65% <ø> (ø)
rust 87.13% <0.00%> (ø)

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.

@acl-cqc
Copy link
Contributor Author

acl-cqc commented Aug 6, 2024

This is a comment-only PR, I reject codecov bot's opinion here :-p

@aborgna-q
Copy link
Collaborator

aborgna-q commented Aug 6, 2024

Do you think there's any custom const for which we wouldn't want to have transitiveness in an equality check? It seems a bit unexpected for that to happen.

@acl-cqc
Copy link
Contributor Author

acl-cqc commented Aug 6, 2024

I can think of crazy ideas, but I can't think of any good ones...
e.g. a Hugr value where we put "some" effort into testing equivalence?

Ok, gone with transitivity too.

@acl-cqc acl-cqc enabled auto-merge August 6, 2024 16:42
@acl-cqc acl-cqc added this pull request to the merge queue Aug 6, 2024
Merged via the queue into main with commit b7f0765 Aug 6, 2024
21 checks passed
@acl-cqc acl-cqc deleted the acl/doc_equal_consts branch August 6, 2024 16:45
@hugrbot hugrbot mentioned this pull request Aug 6, 2024
github-merge-queue bot pushed a commit that referenced this pull request Aug 12, 2024
## 🤖 New release
* `hugr`: 0.10.0 -> 0.11.0
* `hugr-core`: 0.7.0 -> 0.8.0
* `hugr-passes`: 0.6.2 -> 0.7.0
* `hugr-cli`: 0.3.0 -> 0.4.0

<details><summary><i><b>Changelog</b></i></summary><p>

## `hugr`
<blockquote>

## 0.11.0 (2024-08-12)

### Bug Fixes

- [**breaking**] BasicBlockExits should not be `OpTag::DataflowParent`
([#1409](#1409))

### Documentation

- Clarify CustomConst::equal_consts
([#1396](#1396))

### Features

- [**breaking**] Serialised extensions
([#1371](#1371))
- Serialised standard extensions
([#1377](#1377))
- [**breaking**] Update remaining builder methods to "infer by default"
([#1386](#1386))
- Add Eq op to logic extension
([#1398](#1398))
- Improve error message on failed custom op validation
([#1416](#1416))
- [**breaking**] `Extension` requires a version
([#1367](#1367))
</blockquote>

## `hugr-core`
<blockquote>

## 0.8.0 (2024-08-12)

### Bug Fixes

- [**breaking**] BasicBlockExits should not be `OpTag::DataflowParent`
([#1409](#1409))

### Documentation

- Clarify CustomConst::equal_consts
([#1396](#1396))

### Features

- [**breaking**] `Extension` requires a version
([#1367](#1367))
- [**breaking**] Serialised extensions
([#1371](#1371))
- Serialised standard extensions
([#1377](#1377))
- [**breaking**] Update remaining builder methods to "infer by default"
([#1386](#1386))
- Add Eq op to logic extension
([#1398](#1398))
- Improve error message on failed custom op validation
([#1416](#1416))
</blockquote>

## `hugr-passes`
<blockquote>

## 0.7.0 (2024-08-12)

### Features

- [**breaking**] `Extension` requires a version
([#1367](#1367))
</blockquote>

## `hugr-cli`
<blockquote>

## 0.4.0 (2024-08-12)

### Features

- Serialised standard extensions
([#1377](#1377))
- Validate with extra extensions and packages
([#1389](#1389))
- [**breaking**] Move mermaid to own sub-command
([#1390](#1390))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).

---------

Co-authored-by: Craig Roy <craig.roy@cambridgequantum.com>
@hugrbot hugrbot mentioned this pull request Aug 13, 2024
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.

2 participants