Tracking Issue for `Saturating` type #87920

kellerkindt · 2021-08-10T17:21:17Z

This is a tracking issue for the RFC "928" (rust-lang/rfcs#928).
The feature gate for the issue is #![feature(saturating_int_impl)].

About tracking issues

Tracks progress for Saturating type analogue to #32463

Unresolved Questions

What is the MVP for stabilization?
What is the correct impl of Shl and ShalAssign for Saturating<signed>
Add Saturating type (based on Wrapping type) #87921 (comment)
Possible solution: Tracking Issue for Saturating type #87920 (comment)
@avitex https://github.com/avitex/rfcs/blob/master/text/0000-saturating-bit-shifts.md

Steps

implement (Add Saturating type (based on Wrapping type) #87921)
Stabilize saturating_div (Tracking Issue for saturating_div #89381)
Split of saturating bit shifts (Implement saturating_shl and saturating_shr on ints #103441)
Stabilize saturating_int_impl

Implementation history

Implementation Add Saturating type (based on Wrapping type) #87921
- Adds struct Saturating and feature(saturating_int_impl)
Stabilization (TODO)

The text was updated successfully, but these errors were encountered:

Add Saturating type (based on Wrapping type) Tracking rust-lang#87920 ### Unresolved Questions  - [x] ~`impl Div for Saturating<T>` falls back on inner integer division - which seems alright?~ - [x] add `saturating_div`? (to respect division by `-1`) - [x] There is no `::saturating_shl` and `::saturating_shr`. (How to) implement `Shl`, `ShlAssign`, `Shr` and `ShrAssign`? - [naively](3f7d2ce) - [x] ~`saturating_neg` is only implemented on [signed integer types](https://doc.rust-lang.org/std/?search=saturating_n)~ - [x] Is the implementation copied over from the `Wrapping`-type correct for `Saturating`? - [x] `Saturating::rotate_left` - [x] `Saturating::rotate_right` - [x] `Not` - [x] `BitXorOr` and `BitXorOrAssign` - [x] `BitOr` and `BitOrAssign` - [x] `BitAnd` and `BitAndAssign` - [x] `Saturating::swap_bytes` - [x] `Saturating::reverse_bits`

joshtriplett · 2021-09-04T09:44:22Z

FCP for stabilizing saturating_div:
@rfcbot merge

rfcbot · 2021-09-04T09:44:22Z

Team member @joshtriplett has proposed to merge this. The next step is review by the rest of the tagged team members:

Concerns:

~~saturating shifts~~ resolved by Tracking Issue for Saturating type #87920 (comment)

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

Amanieu · 2021-09-04T10:11:25Z

What about the remaining unresolved question regarding the correct behavior of Shl?

kellerkindt · 2021-09-04T10:20:31Z

@kennytm outlined possible implementations for that (#87921 (comment)), but I am not sure what seems to be the correct implementation and I would be happy for any input in that regards.

Amanieu · 2021-09-04T18:09:32Z

I would like to see the situation with saturating shift clarified first before we stabilize this. There is an unsubmited RFC about this (cc @avitex) which has been discussed a bit in Zulip (1 2) but without coming to a conclusion.

@rfcbot concern saturating shifts

kellerkindt · 2021-09-04T19:12:00Z

Hmm, it might be a bit confusing, but I initially intended to only stabilize saturating_div (#88624) and not the whole Saturating type (yet).

@joshtriplett also mentioned it that way here?

Amanieu · 2021-09-04T19:14:30Z

Oh right, I missed that message. TBF it's a bit confusing to have two very different features sharing the same tracking issue.

@rfcbot resove saturating shift

kellerkindt · 2021-09-04T19:17:59Z

Oh right, I missed that message. TBF it's a bit confusing to have two very different features sharing the same tracking issue.

Yes, you are right about that, sorry 😅🙈

@avitex I would appreciate your implementation for shl and shr for the number types to use it in the Saturating type 🙂👍

@Amanieu You seem to have a typo in your second rfcbot command?

Amanieu · 2021-09-06T08:16:58Z

@rfcbot resolve saturating shifts

yaahc · 2021-09-29T18:27:29Z

Oh right, I missed that message. TBF it's a bit confusing to have two very different features sharing the same tracking issue.

@rfcbot resove saturating shift

Should we go ahead and split this tracking issue?

kellerkindt · 2021-09-29T22:14:41Z

That's fine with me, I had the wrong impression that the rfcbot would be run on #88624. What effect does it have on the running poll?

yaahc · 2021-09-29T22:50:43Z

That's fine with me, I had the wrong impression that the rfcbot would be run on #88624. What effect does it have on the running poll?

We would close the poll on this tracking issue and re-open it on the new one and check off the boxes for those who've already approved it here, so effectively none.

kellerkindt · 2021-09-29T22:58:08Z

Okay, I have just created a new tracking issue: #89381

yaahc · 2021-09-29T23:41:57Z

@rfcbot cancel

rfcbot · 2021-09-29T23:41:58Z

@yaahc proposal cancelled.

Rudxain · 2022-10-23T08:56:31Z

I have a question. Why was the name saturating chosen? I had no idea what it was until I read the docs and realized it's just clamped arithmetic. Since it's still a nightly feature, can it be renamed to clamping?

kellerkindt · 2022-10-23T11:11:35Z

I have a question. Why was the name saturating chosen? I had no idea what it was until I read the docs and realized it's just clamped arithmetic. Since it's still a nightly feature, can it be renamed to clamping?

Because all/most the underlying calls on the Integer are also already prefixed with saturating_* :)

https://doc.rust-lang.org/stable/std/intrinsics/fn.saturating_add.html

Amanieu · 2023-08-13T19:07:48Z

The only contentious part of Saturating was the shifts, which are explicitly excluded. The most likely future plan for those is to expose them as methods with informative names.

@rfcbot fcp merge

rfcbot · 2023-08-13T19:07:49Z

Team member @Amanieu has proposed to merge this. The next step is review by the rest of the tagged team members:

No concerns currently listed.

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

rfcbot · 2023-08-22T13:29:23Z

🔔 This is now entering its final comment period, as per the review above. 🔔

rfcbot · 2023-09-01T13:29:29Z

The final comment period, with a disposition to merge, as per the review above, is now complete.

As the automated representative of the governance process, I would like to thank the author for their work and everyone else who contributed.

This will be merged soon.

Also stabilizes saturating_int_assign_impl, rust-langgh-92354. And also make pub fns const where the underlying saturating_* fns became const in the meantime since the Saturating type was created.

Rollup merge of rust-lang#115477 - kellerkindt:stabilized_int_impl, r=dtolnay Stabilize the `Saturating` type Closes rust-lang#87920 Closes rust-lang#92354 Stabilization report rust-lang#87920 (comment) FCP rust-lang#87920 (comment)

Also stabilizes saturating_int_assign_impl, rust-langgh-92354. And also make pub fns const where the underlying saturating_* fns became const in the meantime since the Saturating type was created.

Stabilize the `Saturating` type Closes #87920 Closes #92354 Stabilization report rust-lang/rust#87920 (comment) FCP rust-lang/rust#87920 (comment)

Also stabilizes saturating_int_assign_impl, rust-langgh-92354. And also make pub fns const where the underlying saturating_* fns became const in the meantime since the Saturating type was created.

The implementation in stdlib has been removed as part of stabilizing rust-lang/rust#87920. Support for saturating shifts will be added back once rust-lang/libs-team#230 is fixed.

This patch resolves below: ``` Compiling serde v1.0.198 error[E0658]: use of unstable library feature 'saturating_int_impl' --> /home/sangwan/.cargo/registry/src/index.crates.io-6f17d22bba15001f/serde-1.0.198/src/lib.rs:279:13 | 279 | pub use self::core::num::Saturating; | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = note: see issue #87920 <rust-lang/rust#87920> for more information = help: add `#![feature(saturating_int_impl)]` to the crate attributes t ``` Signed-off-by: Sangwan Kwon <sangwan.kwon@samsung.com>

This fix is for resolving the below error in AnalysisHub. ``` $ ./scripts/deps/rust.sh ... Compiling tempfile v3.10.1 Compiling serde_derive v1.0.201 error[E0658]: use of unstable library feature 'saturating_int_impl' --> /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/serde-1.0.201/src/lib.rs:280:13 | 280 | pub use self::core::num::Saturating; | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = note: see issue #87920 <rust-lang/rust#87920> for more information = help: add `#![feature(saturating_int_impl)]` to the crate attributes to enable ... ``` Signed-off-by: Changho Choi <ch754.choi@samsung.com>

This update will fix the below error in AnalysisHub. ``` $ ./scripts/deps/rust.sh ... Compiling tempfile v3.10.1 Compiling serde_derive v1.0.201 error[E0658]: use of unstable library feature 'saturating_int_impl' --> /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/serde-1.0.201/src/lib.rs:280:13 | 280 | pub use self::core::num::Saturating; | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = note: see issue #87920 <rust-lang/rust#87920> for more information = help: add `#![feature(saturating_int_impl)]` to the crate attributes to enable ... ```

This update will fix the below error in AnalysisHub. ``` $ ./scripts/deps/rust.sh ... Compiling tempfile v3.10.1 Compiling serde_derive v1.0.201 error[E0658]: use of unstable library feature 'saturating_int_impl' --> /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/serde-1.0.201/src/lib.rs:280:13 | 280 | pub use self::core::num::Saturating; | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = note: see issue #87920 <rust-lang/rust#87920> for more information = help: add `#![feature(saturating_int_impl)]` to the crate attributes to enable ... ``` Signed-off-by: Changho Choi <ch754.choi@samsung.com>

This fix is for resolving the below error in AnalysisHub. ``` $ ./scripts/deps/rust.sh ... Compiling tempfile v3.10.1 Compiling serde_derive v1.0.201 error[E0658]: use of unstable library feature 'saturating_int_impl' --> /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/serde-1.0.201/src/lib.rs:280:13 | 280 | pub use self::core::num::Saturating; | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = note: see issue #87920 <rust-lang/rust#87920> for more information = help: add `#![feature(saturating_int_impl)]` to the crate attributes to enable ... ``` Signed-off-by: Changho Choi <ch754.choi@samsung.com>

This update will fix the below error in AnalysisHub. ``` $ ./scripts/deps/rust.sh ... Compiling tempfile v3.10.1 Compiling serde_derive v1.0.201 error[E0658]: use of unstable library feature 'saturating_int_impl' --> /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/serde-1.0.201/src/lib.rs:280:13 | 280 | pub use self::core::num::Saturating; | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = note: see issue #87920 <rust-lang/rust#87920> for more information = help: add `#![feature(saturating_int_impl)]` to the crate attributes to enable ... ``` Signed-off-by: Changho Choi <ch754.choi@samsung.com>

kellerkindt added the C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. label Aug 10, 2021

kellerkindt mentioned this issue Aug 10, 2021

Add Saturating type (based on Wrapping type) #87921

Merged

13 tasks

the8472 changed the title ~~Tracking Issue for Starutating type~~ Tracking Issue for Saturating type Aug 10, 2021

kennytm added the T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. label Aug 28, 2021

kellerkindt mentioned this issue Sep 3, 2021

Stabilize feature saturating_div for rust 1.58.0 #88624

Merged

rfcbot added proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. disposition-merge This issue / PR is in PFCP or FCP with a disposition to merge it. labels Sep 4, 2021

kellerkindt mentioned this issue Sep 29, 2021

Tracking Issue for saturating_div #89381

Closed

2 tasks

rfcbot removed proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. disposition-merge This issue / PR is in PFCP or FCP with a disposition to merge it. labels Sep 29, 2021

kellerkindt mentioned this issue Dec 6, 2021

Tracking issue for core::ops::*<T> on Saturating<T> / Wrapping<T> type #91586

Open

11 tasks

kellerkindt mentioned this issue Dec 28, 2021

Tracking Issue for saturating_int_assign_impl #92354

Closed

6 tasks

rfcbot added proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. disposition-merge This issue / PR is in PFCP or FCP with a disposition to merge it. labels Aug 13, 2023

rfcbot added final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. and removed proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. labels Aug 22, 2023

Amanieu removed the S-waiting-on-team Status: Awaiting decision from the relevant subteam (see the T-<team> label). label Aug 29, 2023

rfcbot added finished-final-comment-period The final comment period is finished for this PR / Issue. to-announce Announce this issue on triage meeting and removed final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. labels Sep 1, 2023

kellerkindt mentioned this issue Sep 2, 2023

Stabilize the Saturating type #115477

Merged

apiraino removed the to-announce Announce this issue on triage meeting label Sep 7, 2023

bors closed this as completed in 6011fd4 Sep 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tracking Issue for `Saturating` type #87920

Tracking Issue for `Saturating` type #87920

kellerkindt commented Aug 10, 2021 •

edited

Loading

joshtriplett commented Sep 4, 2021

rfcbot commented Sep 4, 2021 •

edited by dtolnay

Loading

Amanieu commented Sep 4, 2021

kellerkindt commented Sep 4, 2021

Amanieu commented Sep 4, 2021

kellerkindt commented Sep 4, 2021 •

edited

Loading

Amanieu commented Sep 4, 2021

kellerkindt commented Sep 4, 2021 •

edited

Loading

Amanieu commented Sep 6, 2021

yaahc commented Sep 29, 2021

kellerkindt commented Sep 29, 2021

yaahc commented Sep 29, 2021

kellerkindt commented Sep 29, 2021 •

edited

Loading

yaahc commented Sep 29, 2021

rfcbot commented Sep 29, 2021

Rudxain commented Oct 23, 2022 •

edited

Loading

kellerkindt commented Oct 23, 2022 •

edited

Loading

Amanieu commented Aug 13, 2023

rfcbot commented Aug 13, 2023 •

edited by m-ou-se

Loading

rfcbot commented Aug 22, 2023

rfcbot commented Sep 1, 2023

Tracking Issue for Saturating type #87920

Tracking Issue for Saturating type #87920

Comments

kellerkindt commented Aug 10, 2021 • edited Loading

About tracking issues

Unresolved Questions

Steps

Implementation history

joshtriplett commented Sep 4, 2021

rfcbot commented Sep 4, 2021 • edited by dtolnay Loading

Amanieu commented Sep 4, 2021

kellerkindt commented Sep 4, 2021

Amanieu commented Sep 4, 2021

kellerkindt commented Sep 4, 2021 • edited Loading

Amanieu commented Sep 4, 2021

kellerkindt commented Sep 4, 2021 • edited Loading

Amanieu commented Sep 6, 2021

yaahc commented Sep 29, 2021

kellerkindt commented Sep 29, 2021

yaahc commented Sep 29, 2021

kellerkindt commented Sep 29, 2021 • edited Loading

yaahc commented Sep 29, 2021

rfcbot commented Sep 29, 2021

Rudxain commented Oct 23, 2022 • edited Loading

kellerkindt commented Oct 23, 2022 • edited Loading

Amanieu commented Aug 13, 2023

rfcbot commented Aug 13, 2023 • edited by m-ou-se Loading

rfcbot commented Aug 22, 2023

rfcbot commented Sep 1, 2023

Tracking Issue for `Saturating` type #87920

Tracking Issue for `Saturating` type #87920

kellerkindt commented Aug 10, 2021 •

edited

Loading

rfcbot commented Sep 4, 2021 •

edited by dtolnay

Loading

kellerkindt commented Sep 4, 2021 •

edited

Loading

kellerkindt commented Sep 4, 2021 •

edited

Loading

kellerkindt commented Sep 29, 2021 •

edited

Loading

Rudxain commented Oct 23, 2022 •

edited

Loading

kellerkindt commented Oct 23, 2022 •

edited

Loading

rfcbot commented Aug 13, 2023 •

edited by m-ou-se

Loading