【libm】0库入口文件（lib.rs）

一、源码

lib.rs是libm（纯 Rust 实现的数学函数库）的入口文件。

//! libm in pure Rust
#![no_std]
#![cfg_attr(intrinsics_enabled, allow(internal_features))]
#![cfg_attr(intrinsics_enabled, feature(core_intrinsics))]
#![cfg_attr(all(intrinsics_enabled, target_family = "wasm"), feature(wasm_numeric_instr))]
#![cfg_attr(f128_enabled, feature(f128))]
#![cfg_attr(f16_enabled, feature(f16))]
#![allow(clippy::assign_op_pattern)]
#![allow(clippy::deprecated_cfg_attr)]
#![allow(clippy::eq_op)]
#![allow(clippy::excessive_precision)]
#![allow(clippy::float_cmp)]
#![allow(clippy::int_plus_one)]
#![allow(clippy::many_single_char_names)]
#![allow(clippy::mixed_case_hex_literals)]
#![allow(clippy::needless_late_init)]
#![allow(clippy::needless_return)]
#![allow(clippy::unreadable_literal)]
#![allow(clippy::zero_divided_by_zero)]
#![forbid(unsafe_op_in_unsafe_fn)]

mod libm_helper;
mod math;

use core::{f32, f64};

pub use libm_helper::*;

pub use self::math::*;

1. 文件注释

//! libm in pure Rust

//! 是模块级文档注释，说明这个库是一个纯 Rust 实现的 libm（数学函数库）。

2. 全局属性（#![…]）
   #![no_std]

• 声明该库不依赖 Rust 标准库（std），适用于嵌入式系统或无操作系统的环境。

#![cfg_attr(intrinsics_enabled, ...)]

• 条件编译：如果 intrinsics_enabled 特性启用，则允许使用内部特性（internal_features）和 core_intrinsics（编译器内置函数）。

• 对 WASM 目标额外启用 wasm_numeric_instr（WASM 数字指令优化）。

#![cfg_attr(f128_enabled, feature(f128))]

• 如果 f128_enabled 启用，则启用实验性的 f128（128 位浮点数）支持（Rust 尚未稳定此功能）。

#![cfg_attr(f16_enabled, feature(f16))]

• 如果 f16_enabled 启用，则启用实验性的 f16（16 位浮点数）支持。

3. Clippy 忽略规则

#![allow(clippy::assign_op_pattern)]
#![allow(clippy::deprecated_cfg_attr)]
...
#![allow(clippy::zero_divided_by_zero)]

• 禁用 Clippy（Rust 的代码风格检查工具）的某些警告，例如：

  • float_cmp：允许浮点数直接比较（数学库需要）。

  • unreadable_literal：允许长数字字面量（如 3.14159265358979323846）。

  • zero_divided_by_zero：允许 0.0 / 0.0（数学库需要处理 NaN）。

4. 安全限制

#![forbid(unsafe_op_in_unsafe_fn)]

• 强制在 unsafe fn 中明确标记 unsafe 代码块（提高安全性）。

5. 模块声明

mod libm_helper;
mod math;

• 定义两个子模块：

  1. libm_helper：可能包含辅助函数或宏。

2. math：核心数学函数实现（如 sin、sqrt）。

3. 导入依赖

use core::{f32, f64};

• 从 core 库导入 f32 和 f64 类型（no_std 环境下替代 std 的浮点类型）。

7. 公开 API

pub use libm_helper::*;
pub use self::math::*;

• 将 libm_helper 和 math 模块的所有公共项（函数/类型）导出为库的公共 API。

二、关键点总结

1. 纯 Rust 实现：不依赖 std，适合嵌入式或无 OS 环境。

2. 条件编译：支持 WASM、f16/f128 等实验性功能。

3. 数学函数：核心逻辑在 math 模块中实现（如 sin、exp）。

4. 安全优先：严格限制 unsafe 的使用。

三、示例：如何使用 libm

use libm::{sqrt, sin};

fn main() {
    println!("sqrt(2.0) = {}", sqrt(2.0_f64)); // 1.4142135623730951
    println!("sin(PI/2) = {}", sin(1.5707963267948966_f64)); // ~1.0
}

这个库的设计目标是在不依赖系统 libm 的情况下提供标准数学函数，同时保持高性能和安全性。