rust/library/compiler-builtins/libm
Trevor Gross 573ded2ee8 Port the most recent version of Musl's sqrt as a generic algorithm
Musl commit 97e9b73d59 ("math: new software sqrt") adds a new algorithm
using Goldschmidt division. Port this algorithm to Rust and make it
generic, which shows a notable performance improvement over the existing
algorithm.

This also allows adding square root routines for `f16` and `f128`.
2025-01-22 05:31:13 +00:00
..
.github/workflows Enable force-soft-floats for extensive tests 2025-01-22 05:31:13 +00:00
ci Add a retry to the musl download 2025-01-21 22:02:48 -05:00
crates Don't set opt_level in the musl build script 2025-01-22 05:22:12 +00:00
etc Port the most recent version of Musl's sqrt as a generic algorithm 2025-01-22 05:31:13 +00:00
src Port the most recent version of Musl's sqrt as a generic algorithm 2025-01-22 05:31:13 +00:00
.editorconfig add generic libm helper 2023-01-17 20:41:24 +01:00
.git-blame-ignore-revs Add a .git-blame-ignore-revs file 2024-10-26 20:30:41 -05:00
.gitignore Ignore files relevant to benchmarking 2025-01-21 07:58:05 +00:00
.rustfmt.toml Add a rustfmt.toml file matching rust-lang/rust 2024-10-26 20:28:28 -05:00
build.rs Add a release-checked profile with debug and overflow assertions 2025-01-11 20:35:30 -05:00
Cargo.toml Add benchmarks using iai-callgrind 2025-01-16 09:07:19 +00:00
CHANGELOG.md chore: release v0.2.11 2024-10-28 20:08:07 +00:00
configure.rs Account for optimization levels other than numbers 2025-01-07 17:58:54 -05:00
CONTRIBUTING.md Enable build-mpfr and build-musl by default 2025-01-13 03:53:46 +00:00
LICENSE.txt Update licensing to MIT AND (MIT OR Apache-2.0) 2024-10-26 17:09:57 -05:00
README.md Use https: links in README.md 2024-11-14 18:13:10 +00:00

libm

A port of MUSL's libm to Rust.

Goals

The short term goal of this library is to enable math support (e.g. sin, atan2) for the wasm32-unknown-unknown target (cf. rust-lang/compiler-builtins). The longer term goal is to enable math support in the core crate.

Already usable

This crate is on crates.io and can be used today in stable #![no_std] programs.

The API documentation can be found here.

Benchmark

The benchmarks are located in crates/libm-bench and require a nightly Rust toolchain. To run all benchmarks:

cargo +nightly bench --all

Contributing

Please check CONTRIBUTING.md

Minimum Rust version policy

This crate supports rustc 1.63 and newer.

License

Usage is licensed under the MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT).

Contribution

Contributions are licensed under both the MIT license and the Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0). Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as mentioned, without any additional terms or conditions.

See LICENSE.txt for full details.