Skip to content

Readme improvements (https://github.com/rust-lang/crates.io/pull/11441) #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Readme improvements (https://github.com/rust-lang/crates.io/pull/11441) #256

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,9 @@ Most methods and traits available on the underlying type are available on the ty

Most constants are also available, with the most appropriate typed float type (except `NAN` for obvious reasons) in the [`tf64`] and [`tf32`] modules (in [`tf64::consts`] and [`tf32::consts`] respectively when the constant comes from [`core::f64::consts`] or [`core::f32::consts`]). Those modules are named that way to avoid conflicts or confusion with the primitives [`f32`] and [`f64`].

⚠️ Like for primitives [`f32`] and [`f64`],`-0.0 == +0.0` is `true` for all types of this crate.
To facilitate comparisons, the methods `is_positive_zero` and `is_negative_zero` are added.
> [!WARNING]
> Like for primitives [`f32`] and [`f64`],`-0.0 == +0.0` is `true` for all types of this crate.
> To facilitate comparisons, the methods `is_positive_zero` and `is_negative_zero` are added.

# Traits implemented

Expand Down Expand Up @@ -153,7 +154,8 @@ A `panic!` triggered in any other way is considered a security bug and should be

This crate is designed to have a minimal overhead at runtime, in terms of memory, speed and binary size.

It can even be faster than using primitives [`f32`] and [`f64`] directly, as it may avoids some checks by using compiler hints and can use some faster implementations in some cases.
> [!TIP]
> It can even be faster than using primitives [`f32`] and [`f64`] directly, as it may avoids some checks by using compiler hints and can use some faster implementations in some cases.

### Overhead

Expand Down