assert_float_eq

用于检查用户定义容差内的浮点数相等的断言。在 std 和 no_std 环境中均有效。

目录

• 入门
• 描述
• 文档
• 许可证
• 贡献

入门

首先，将 assert_float_eq 添加到你的 Cargo.toml

[dependencies]
assert_float_eq = "1"

然后，在 lib.rs 中导入宏

#[macro_use]
extern crate assert_float_eq;

最后，像使用其他Rust断言一样使用断言

assert_float_absolute_eq!(3.0, 4.0, 1.0);   // 4.0-3.0 <= 1.0
assert_float_relative_eq!(4.0, 3.9, 0.03);  // (4.0-3.0) / 4.0 <= 0.3
assert_f32_near!(1.0e-45, 7.0e-45, 4);      // exactly 4 steps away
assert_f64_near!(5.0e-324, 2.5e-323, 4);    // exactly 4 steps away

当需要更柔软的错误处理时，assert_float_eq 还包括 "期望"，它返回一个 Result<(), T: Display>，表示比较是否成功

expect_float_absolute_eq!(3.0, 4.0, 1.0);   // Ok(_)
expect_float_absolute_eq!(3.0, 4.0, 0.9);   // Err(_)

expect_float_relative_eq!(4.0, 3.9, 0.03);   // Ok(_)
expect_float_relative_eq!(4.0, 3.9, 0.02);   // Err(_)

expect_f32_near!(1.0e-45, 7.0e-45, 4);       // Ok(_)
expect_f32_near!(1.0e-45, 7.0e-45, 3);       // Err(_)

expect_f64_near!(5.0e-324, 2.5e-323, 4);     // Ok(_)
expect_f64_near!(5.0e-324, 2.5e-323, 3);     // Err(_)

描述

assert_float_eq 导出4个宏，每个宏都提供了比较浮点数的不同启发式方法。

assert_float_absolute_eq 比较的是，两个浮点数之间的差的绝对值小于epsilon（默认为1e-6），即 | a - b | < epsilon。这是一个最容易理解的宏，因为它确保两个浮点数之间的差异低于某个固定的阈值。然而，对于非常小或非常大的浮点数，绝对比较可能会导致错误的比较，因为误差容忍度不会随着浮点精度而缩放。

assert_float_relative_eq 比较浮点数之间的值，使得浮点数之间差异的相对值小于 epsilon（默认 1e-6），或者 (| a - b | / max(|a|, |b|) < epsilon`。这是一个易于理解的宏，并且适用于大浮点数，然而，它对于小（非正常）浮点数，尤其是 0 来说会失败。例如，1e-45 和 3e-45 之间的相对误差约为 67%，尽管它们之间没有 32 位表示。