Rust中saturating_sub的使用

留言

为了防止整数溢出，开发人员通常使用checked_add、checked_sub、saturating_add、saturating_sub等函数，而不是简单的加法和减法（+、-）


关于饱和减法


saturating 是 使饱和之意

饱和减法（Saturating Subtraction）是一种数学运算，常用于计算机编程中，特别是在处理固定大小的数值类型（如整数）时。在饱和减法中，如果减法运算的结果超出了数值类型的表示范围，结果会被“饱和”到该类型的最小（或最大）可表示值，而不是产生溢出。

例如:

1
2
3
4
5
6
fn main() {
    let a: u8 = 50;
    let b: u8 = 100;
    let result = a.saturating_sub(b); // 结果为 0
    println!("结果为:{}", result);
}

u8即 无符号 8 位整数,可表示的范围为0 到 255.

对于a-b,如果不使用saturating_sub, 会因为a-b的结果超出u8的表示范围而溢出,发生报错.

使用saturating_sub, 则不会产生溢出, 会是u8类型的最小值,即0


使用饱和减法可以避免由于溢出导致的不期望的行为，确保结果始终在有效的数值范围内。在 Rust 语言中，标准库提供了 saturating_sub 方法来执行饱和减法运算。


关于saturating_sub


在 Rust 中，saturating_sub 方法是数值类型（如 u32, i32, u64, i64 等）的一个方法，用于执行饱和减法运算。

其作用可以：

  • 防止溢出：在减法运算中防止整数溢出，确保结果始终在有效范围内。
  • 提高安全性：避免因溢出导致的不可预测行为，增加代码的健壮性。

如何使用：


saturating_sub 方法可以直接调用在任何数值类型的实例上。它接收一个参数，即要减去的值，并返回计算结果。

示例：

1
2
3
4
5
6
7
8
9
10
11
12
fn main() {
    let a: u32 = 100;
    let b: u32 = 200;

    // 正常减法可能导致无符号整数下溢
    let normal_sub = a.wrapping_sub(b); // 结果可能是一个非常大的数.
    // 饱和减法避免了下溢
    let saturating_sub = a.saturating_sub(b); // 结果为 0

    println!("Normal Subtraction: {}", normal_sub); //  Normal Subtraction: 4294967196
    println!("Saturating Subtraction: {}", saturating_sub); // Saturating Subtraction: 0
}

在这个例子中，a.saturating_sub(b) 防止了因为 a - b（100 - 200）而导致的下溢。对于无符号整数 u32 来说，这种下溢会导致结果变成一个非常大的数，因为 u32 不能表示负数。使用 saturating_sub 后，当减法结果为负时，它会返回 0（即 u32 能表示的最小值）。


关于 wrapping_sub


上例中用到了wrapping_sub方法, 即“包裹减法”（wrapping subtraction）。

和普通的减法操作相比，当发生溢出时，它会“包裹”到类型的最大或最小值，而不是引发溢出错误或产生未定义行为。 和saturating_sub正好相对.

wrapping_sub 的作用

  • 处理溢出：在减法运算中，如果结果超出了类型的表示范围，wrapping_sub 会使结果在类型的有效范围内循环（或“包裹”）。对于无符号类型，如果结果是负数，它会包裹到类型的最大值；对于有符号类型，它会在最大值和最小值之间循环。

  • 避免溢出错误：在“调试”模式下，Rust 默认会检查算术溢出。使用 wrapping_sub 可以避免因溢出而导致的运行时错误。


与直接减法相比:

  • 直接减法：在 Rust 中，直接使用 - 运算符进行减法时，如果在“调试”模式下发生溢出，程序会触发 panic（崩溃）。但在“发布”模式下，Rust 默认不检查溢出，此时溢出的行为类似于 wrapping_sub，但这并不是明确的行为保证。

  • wrapping_sub 方法：无论是在调试模式还是发布模式下，wrapping_sub 都会明确地进行包裹减法，确保结果是可预测的。


包裹减法的示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
fn main() {
    let a: u8 = 0;
    let b: u8 = 1;

    // 直接减法，在调试模式下将会 panic
    // let result = a - b;

    // 包裹减法
    let result1 = a.wrapping_sub(b); // 结果为 255，因为 u8 类型下溢
    let result2 = a.saturating_sub(b);

    println!("结果1为:{}", result1); // 结果为:255
    println!("结果2为:{}", result2); // 结果为:0
}

在这个例子中，0 - 1 对于 u8 类型来说是下溢。使用 wrapping_sub 后，结果会从 0 下溢到 255，而不是引发 panic。



总结一下, saturating_加减乘除和wrapping_加减乘除 都是提供了一种明确和安全的方式来处理可能的溢出情况，确保即使在溢出发生时，程序行为也是可预测和一致的。


探索 Rust：标量类型、整数溢出与浮点数操作详解

https://weibo.com/ttarticle/p/show?id=2309404924972723471160

https://vimsky.com/examples/usage/rust-std-primitive.u16.saturating_sub-rt.html