Tracking Issue for `unsigned_is_multiple_of` #128101

folkertdev · 2024-07-23T16:01:31Z

Feature gate: #![feature(unsigned_is_multiple_of)]
ACP: rust-lang/libs-team#404

This is a tracking issue for the .is_multiple_of method on unsigned integers.

Returns true if self is an integer multiple of rhs, and false otherwise.

This function is equivalent to self % rhs == 0, except that it will not panic for rhs == 0. Instead, 0.is_multiple_of(0) == true, and for any non-zero n, n.is_multiple_of(0) == false.

If you have a real usecase for this function on signed integer types, let us know! That was not included for simplicity, but if a usecase comes up, adding it will be considered.

Public API

A version of this for all the unsigned types

fn is_multiple_of(lhs: u64, rhs: u64) -> bool {
    match rhs {
        // prevent division by zero
        0 => lhs == 0,
        _ => lhs % rhs == 0,
    }
}

Steps / History

Implementation: add is_multiple_of for unsigned integer types #128103
Final comment period (FCP)¹
Stabilization PR stabilize unsigned_is_multiple_of #137383

Unresolved Questions

None yet.

https://std-dev-guide.rust-lang.org/feature-lifecycle/stabilization.html ↩

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

…e-of, r=Amanieu add `is_multiple_of` for unsigned integer types tracking issue: rust-lang#128101 This adds the `.is_multiple_of` method on unsigned integers. Returns `true` if `self` is an integer multiple of `rhs`, and false otherwise. This function is equivalent to `self % rhs == 0`, except that it will not panic for `rhs == 0`. Instead, `0.is_multiple_of(0) == true`, and for any non-zero `n`, `n.is_multiple_of(0) == false`.

Rollup merge of rust-lang#128103 - folkertdev:unsigned-int-is-multiple-of, r=Amanieu add `is_multiple_of` for unsigned integer types tracking issue: rust-lang#128101 This adds the `.is_multiple_of` method on unsigned integers. Returns `true` if `self` is an integer multiple of `rhs`, and false otherwise. This function is equivalent to `self % rhs == 0`, except that it will not panic for `rhs == 0`. Instead, `0.is_multiple_of(0) == true`, and for any non-zero `n`, `n.is_multiple_of(0) == false`.

diondokter · 2025-01-16T14:44:52Z

I'd love to have this stable at some point. It's not a must have, but it makes code much nicer to read.

In my case right now, I need to check if the hardware busses have dividers that are a multiple of the main bus. You judge what's better to read and conveys more meaning:

let apb_dividers = [config.apb1_divider, config.apb2_divider, config.apb3_divider, config.apb4_divider];
for apb_divider in apb_dividers {
    assert!(
        apb_divider.div_value() % config.core_clock_prescaler.div_value()
            == 0
    );
}

Or

let apb_dividers = [config.apb1_divider, config.apb2_divider, config.apb3_divider, config.apb4_divider];
for apb_divider in apb_dividers {
    assert!(
        apb_divider.div_value()
            .is_multiple_of(config.core_clock_prescaler.div_value())
    );
}

joshtriplett · 2025-01-16T14:56:26Z

This has been implemented for a while, it's simple and straightforward, it's useful, people want it, and there are no known issues with it.

Shall we stabilize it?

@rfcbot merge

rfcbot · 2025-01-16T14:56:28Z

Team member @joshtriplett 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 · 2025-02-11T15:35:06Z

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

rfcbot · 2025-02-21T15:39:43Z

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.

…ultiple-of, r=Noratrieb stabilize `unsigned_is_multiple_of` tracking issue: rust-lang#128101 fcp completed in: rust-lang#128101 (comment) ### Public API A version of this for all the unsigned types ```rust fn is_multiple_of(lhs: u64, rhs: u64) -> bool { match rhs { // prevent division by zero 0 => lhs == 0, _ => lhs % rhs == 0, } } ```

Rollup merge of rust-lang#137383 - folkertdev:stabilize-unsigned-is-multiple-of, r=Noratrieb stabilize `unsigned_is_multiple_of` tracking issue: rust-lang#128101 fcp completed in: rust-lang#128101 (comment) ### Public API A version of this for all the unsigned types ```rust fn is_multiple_of(lhs: u64, rhs: u64) -> bool { match rhs { // prevent division by zero 0 => lhs == 0, _ => lhs % rhs == 0, } } ```

…f, r=Noratrieb stabilize `unsigned_is_multiple_of` tracking issue: rust-lang/rust#128101 fcp completed in: rust-lang/rust#128101 (comment) ### Public API A version of this for all the unsigned types ```rust fn is_multiple_of(lhs: u64, rhs: u64) -> bool { match rhs { // prevent division by zero 0 => lhs == 0, _ => lhs % rhs == 0, } } ```

…ultiple-of, r=Noratrieb stabilize `unsigned_is_multiple_of` tracking issue: rust-lang#128101 fcp completed in: rust-lang#128101 (comment) ### Public API A version of this for all the unsigned types ```rust fn is_multiple_of(lhs: u64, rhs: u64) -> bool { match rhs { // prevent division by zero 0 => lhs == 0, _ => lhs % rhs == 0, } } ```

folkertdev added C-tracking-issue Category: An issue tracking the progress of sth. like the implementation of an RFC T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. labels Jul 23, 2024

folkertdev mentioned this issue Jul 23, 2024

add is_multiple_of for unsigned integer types #128103

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 Jan 16, 2025

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 Feb 11, 2025

rustbot mentioned this issue Feb 21, 2025

Tracking issue for release notes of #128101: Tracking Issue for unsigned_is_multiple_of #137380

Open

3 tasks

folkertdev mentioned this issue Feb 21, 2025

stabilize unsigned_is_multiple_of #137383

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tracking Issue for `unsigned_is_multiple_of` #128101

Tracking Issue for `unsigned_is_multiple_of` #128101

folkertdev commented Jul 23, 2024 •

edited

Loading

diondokter commented Jan 16, 2025

joshtriplett commented Jan 16, 2025

rfcbot commented Jan 16, 2025 •

edited by Amanieu

Loading

rfcbot commented Feb 11, 2025

rfcbot commented Feb 21, 2025

Tracking Issue for unsigned_is_multiple_of #128101

Tracking Issue for unsigned_is_multiple_of #128101

Comments

folkertdev commented Jul 23, 2024 • edited Loading

Public API

Steps / History

Unresolved Questions

Footnotes

diondokter commented Jan 16, 2025

joshtriplett commented Jan 16, 2025

rfcbot commented Jan 16, 2025 • edited by Amanieu Loading

rfcbot commented Feb 11, 2025

rfcbot commented Feb 21, 2025

Tracking Issue for `unsigned_is_multiple_of` #128101

Tracking Issue for `unsigned_is_multiple_of` #128101

folkertdev commented Jul 23, 2024 •

edited

Loading

rfcbot commented Jan 16, 2025 •

edited by Amanieu

Loading