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

fix: Disallow non-finite values for ConstF64 #1075

Merged
merged 5 commits into from
May 17, 2024
Merged

fix: Disallow non-finite values for ConstF64 #1075

merged 5 commits into from
May 17, 2024

Conversation

cqc-alec
Copy link
Collaborator

Fixes #1049 .

Other solutions (custom serialization/deserialization for ConstF64, or custom deserializer taking "null" to NaN) are difficult or otherwise problematic, and it may actually be a good thing to disallow non-finite float constants as it can catch bugs earlier.

@cqc-alec cqc-alec requested a review from a team as a code owner May 17, 2024 12:28
@cqc-alec cqc-alec requested a review from doug-q May 17, 2024 12:28
@codecov Codecov
Copy link

codecov bot commented May 17, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 85.71429% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 86.56%. Comparing base (d2087ce) to head (4eba7aa).
Report is 1 commits behind head on main.

Files Patch % Lines
.../std_extensions/arithmetic/float_ops/const_fold.rs 50.00% 5 Missing ⚠️
hugr/src/std_extensions/arithmetic/float_types.rs 80.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1075      +/-   ##
==========================================
+ Coverage   86.49%   86.56%   +0.06%     
==========================================
  Files          83       83              
  Lines       17547    17586      +39     
  Branches    17547    17586      +39     
==========================================
+ Hits        15178    15223      +45     
+ Misses       1548     1543       -5     
+ Partials      821      820       -1
Flag Coverage Δ
rust 86.56% <85.71%> (+0.06%) ⬆️

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.

doug-q
doug-q approved these changes May 17, 2024
View reviewed changes
Copy link
Collaborator

@doug-q doug-q left a comment

Choose a reason for hiding this comment

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

A bit disappointed to not support these, but this is fine. We can add them later if we need them.

specification/hugr.md
@@ -1782,6 +1782,9 @@ Other operations:
The `float64` type represents IEEE 754-2019 floating-point data of 64
bits.

Non-finite `float64` values (i.e. NaN and ±infinity) are not allowed in `Const`
nodes.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is also true for arbitrary yaml in CustomTypeArg and node metadata.

@cqc-alec cqc-alec added this pull request to the merge queue May 17, 2024
Merged via the queue into main with commit 4dba950 May 17, 2024
18 checks passed
@cqc-alec cqc-alec deleted the ae/bannan branch May 17, 2024 13:52
This was referenced May 17, 2024
Closed
Merged
github-merge-queue bot pushed a commit that referenced this pull request May 20, 2024
@github-actions @doug-q
chore: release v0.4.0 (#1081)
0171ccd 
## 🤖 New release
* `hugr`: 0.3.1 -> 0.4.0 (⚠️ API breaking changes)

### ⚠️ `hugr` breaking changes

```
--- failure inherent_method_const_removed: pub method is no longer const ---

Description:
A publicly-visible method or associated fn is no longer `const` and can no longer be used in a `const` context.
        ref: https://doc.rust-lang.org/reference/const_eval.html
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.31.0/src/lints/inherent_method_const_removed.ron

Failed in:
  ConstF64::new in /tmp/.tmpwo5blB/hugr/hugr/src/std_extensions/arithmetic/float_types.rs:43

--- failure struct_missing: pub struct removed or renamed ---

Description:
A publicly-visible struct cannot be imported by its prior path. A `pub use` may have been removed, or the struct 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.31.0/src/lints/struct_missing.ron

Failed in:
  struct hugr::ops::constant::ExtensionValue, previously in file /tmp/.tmpq1W6bC/hugr/src/ops/constant.rs:184
```

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

<blockquote>

## 0.4.0 (2024-05-20)

### Bug Fixes

- Disallow non-finite values for `ConstF64`
([#1075](#1075))
- Serialization round-trips
([#948](#948))
- [**breaking**] Combine `ConstIntU` and `ConstIntS`
([#974](#974))
- Disable serialisation tests when miri is active
([#977](#977))
- [**breaking**] Serialisation schema
([#968](#968))
- Correct constant fold for `fne`.
([#995](#995))
- [**breaking**] Serialisation fixes
([#997](#997))
- [**breaking**] OpDef serialisation
([#1013](#1013))
- NaryLogicOp constant folding
([#1026](#1026))

### Features

- Add verification to constant folding
([#1030](#1030))
- Add `Const::get_custom_value`
([#1037](#1037))
- Add serialization schema for metadata
([#1038](#1038))
- 'Replace' rewrite returns node map
([#929](#929))
- `new` methods for leaf ops
([#940](#940))
- Add `string` type and `print` function to `prelude`
([#942](#942))
- `CustomOp::extension` utility function
([#951](#951))
- [**breaking**] Add `non_exhaustive` to various enums
([#952](#952))
- Encoder metadata in serialized hugr
([#955](#955))
- [**breaking**] Bring back Value
([#967](#967))
- Add LoadFunction node ([#947](#947))
- Add From impls for TypeArg
([#1002](#1002))
- Constant-folding of integer and logic operations
([#1009](#1009))
- [**breaking**] Update serialisation schema, implement `CustomConst`
serialisation ([#1005](#1005))
- Merge basic blocks algorithm
([#956](#956))
- [**breaking**] Allow panic operation to have any input and output
wires ([#1024](#1024))

### Refactor

- [**breaking**] Rename `crate::ops::constant::ExtensionValue` =>
`OpaqueValue` ([#1036](#1036))
- Outline hugr::serialize::test
([#976](#976))
- [**breaking**] Replace SmolStr identifiers with wrapper types.
([#959](#959))
- Separate extension validation from the rest
([#1011](#1011))
- Remove "trait TypeParametrised"
([#1019](#1019))

### Testing

- Reorg OutlineCfg/nest_cfgs tests so hugr doesn't depend on algorithm
([#1007](#1007))
- Ignore tests which depend on typetag when cfg(miri)
([#1051](#1051))
- Really ignore tests which depend on typetag when cfg(miri)
([#1058](#1058))
- Proptests for round trip serialisation of `Type`s and `Op`s.
([#981](#981))
- Add a test of instantiating an extension set
([#939](#939))
- Ignore serialisation tests when using miri
([#975](#975))
- [**breaking**] Test roundtrip serialisation against strict + lax
schema ([#982](#982))
- Fix some bad assert_matches
([#1006](#1006))
- Expand test of instantiating extension sets
([#1003](#1003))
- Fix unconnected ports in extension test
([#1010](#1010))

</blockquote>


</p></details>

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

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Douglas Wilson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@doug-q doug-q doug-q 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.

floats do not perfectly round trip serialize.
2 participants
@cqc-alec @doug-q