core_math_rs/lib.rs
1//! [![CI Status]][workflow] [![MSRV]][repo] [![Rust Doc Main]][docs]
2//!
3//! [CI Status]: https://img.shields.io/github/actions/workflow/status/juntyr/core-math-rs/ci.yml?branch=main
4//! [workflow]: https://github.com/juntyr/core-math-rs/actions/workflows/ci.yml?query=branch%3Amain
5//!
6//! [MSRV]: https://img.shields.io/badge/MSRV-1.85.0-blue
7//! [repo]: https://github.com/juntyr/core-math-rs
8//!
9//! [Rust Doc Main]: https://img.shields.io/badge/docs-main-blue
10//! [docs]: https://juntyr.github.io/core-math-rs/core_math_rs
11//!
12//! # core-math-rs
13//!
14//! In-progress Rust port of the [CORE-MATH] project, which provides
15//! on-the-shelf open-source mathematical functions with correct rounding.
16//!
17//! ## Cargo Features
18//!
19//! - `f16`: enable nightly support for `f16` functions
20//!
21//! ## Related Projects
22//!
23//! - [`core-math`]: safe Rust bindings to the [CORE-MATH] C library,
24//! which we test against
25//!
26//! [CORE-MATH]: https://core-math.gitlabpages.inria.fr/
27//! [`core-math`]: https://github.com/jdh8/core-math
28
29#![cfg_attr(feature = "f16", feature(f16))]
30#![cfg_attr(feature = "f16", feature(f32_from_f16))]
31
32#[cfg(feature = "f16")]
33pub mod f16;