Deprecate use-intrinsics, update docs&CI

Author: VoidStarKat

.circleci/config.yml

@@ -48,11 +48,11 @@ workflows:
       - rust:
           name: Rust AArch64 (stable)
           toolchain: stable
-          features: --features=std,serde,num-traits,bytemuck,zerocopy
+          features: --all-features
       - rust:
           name: Rust AArch64 (1.61.0)
           toolchain: 1.61.0
-          features: --features=std,serde,num-traits,bytemuck,zerocopy
+          features: --all-features
       - rust:
           name: Rust AArch64 (nightly)
           toolchain: nightly

CHANGELOG.md

@@ -4,10 +4,29 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Support for Kani Rust Verifier. By [@cameron1024].
+- Support for `rand_distr::Distribution` implementations behind `rand_distr` optional cargo
+  feature. By [@coreylowman].
+- Floating point formatting options in `Display` and `Debug` implementations. By [@eiz].
+
 ### Changed
 - **Breaking Change** Minimum supported Rust version is now 1.61.
+- **Breaking Change** Minimum supported Rust version policy reverted to original policy of allowing
+  minimum supported Rust version updates for minor releases instead of only major to avoid
+  segmentation and allow optimizing hardware implementations without unnecessary major releases.
 - AArch64 now uses FP16 hardware support for conversions and math operations when available.
 
+### Deprecated
+- `use-intrinsics` cargo feature no longer used. Hardware support will now always be used whenever
+  possible. A future version may output deprecation warnings if this feature is enabled.
+
+### Fixed
+- Improve code generation of `leading_zeros` functions by inlining. By [@encounter].
+- `Sum` implementation of `bf16` incorrectly performed product instead of sum. By [@wx-csy].
+- Compile failed when `serde` cargo feature enabled but `std` not enabled.
+- Incorrect black boxing of benchmark tests.
+
 ## [2.2.1] - 2023-01-08 <a name="2.2.1"></a>
 ### Changed
 - Reduced unnecessary bounds checks for SIMD operations on slices. By [@Shnatsel].
@@ -294,6 +313,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 [@Nilstrieb]: https://github.com/Nilstrieb
 [@joseluis]: https://github.com/joseluis
 [@Shnatsel]: https://github.com/Shnatsel
+[@cameron1024]: https://github.com/cameron1024
+[@encounter]: https://github.com/encounter
+[@coreylowman]: https://github.com/coreylowman
+[@wx-csy]: https://github.com/wx-csy
+[@eiz]: https://github.com/eiz
 
 
 [Unreleased]: https://github.com/starkat99/half-rs/compare/v2.2.1...HEAD

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "half"
 # Remember to keep in sync with html_root_url crate attribute
-version = "3.0.0-dev"
+version = "2.3.0-dev"
 authors = ["Kathryn Long <[email protected]>"]
 description = "Half-precision floating point f16 and bf16 types for Rust implementing the IEEE 754-2008 standard binary16 and bfloat16 types."
 repository = "https://github.com/starkat99/half-rs"
@@ -16,7 +16,7 @@ exclude = [".git*", ".editorconfig"]
 [features]
 default = ["std"]
 std = ["alloc"]
-use-intrinsics = []
+use-intrinsics = [] # Deprecated
 alloc = []
 rand_distr = ["dep:rand", "dep:rand_distr"]
 

Makefile.toml

@@ -5,7 +5,7 @@ min_version = "0.35.0"
 CI_CARGO_TEST_FLAGS = { value = "--locked -- --nocapture", condition = { env_true = [
     "CARGO_MAKE_CI",
 ] } }
-CARGO_MAKE_CARGO_ALL_FEATURES = { source = "${CARGO_MAKE_RUST_CHANNEL}", default_value = "--features=std,serde,num-traits,bytemuck,zerocopy,rand_distr", mapping = { "nightly" = "--all-features" } }
+CARGO_MAKE_CARGO_ALL_FEATURES = { source = "${CARGO_MAKE_RUST_CHANNEL}", default_value = "--all-features", mapping = { "nightly" = "--all-features" } }
 CARGO_MAKE_CLIPPY_ARGS = { value = "${CARGO_MAKE_CLIPPY_ALL_FEATURES_WARN}", condition = { env_true = [
     "CARGO_MAKE_CI",
 ] } }

README.md

@@ -13,8 +13,7 @@ arithmetic operations. Hardware support for these operations will be used whenev
 is available—either through instrinsics or targeted assembly—although a nightly Rust toolchain may
 be required for some hardware.
 
-This crate provides [`no_std`](https://rust-embedded.github.io/book/intro/no-std.html) support by
-default so can easily be used in embedded code where a smaller float format is most useful.
+This crate provides [`no_std`](https://rust-embedded.github.io/book/intro/no-std.html) support so can easily be used in embedded code where a smaller float format is most useful.
 
 *Requires Rust 1.61 or greater.* If you need support for older versions of Rust, use 1.x versions of
 this crate.
@@ -26,11 +25,6 @@ See the [crate documentation](https://docs.rs/half/) for more details.
 - **`serde`** - Implement `Serialize` and `Deserialize` traits for `f16` and `bf16`. This adds a
   dependency on the [`serde`](https://crates.io/crates/serde) crate.
 
-- **`use-intrinsics`** — Use unstable hardware intrinsics for `f16` and `bf16` conversions if
-  available on the compiler target. By default, only hardware support compatible with the Rust
-  stable toolchain will be used, or software emulation otherwise. **Available only on
-  Rust nightly channel.**
-
 - **`alloc`** — Enable use of the [`alloc`](https://doc.rust-lang.org/alloc/) crate when not using
   the `std` library.
 
@@ -64,7 +58,7 @@ for specific CPU features which avoids the runtime overhead and works in a `no_s
 
 | Architecture | CPU Target Feature | Notes |
 | ------------ | ------------------ | ----- |
-| `x86`/`x86_64` | `f16c` | **Only on nightly Rust toolchain with `use-intrinsics` cargo feature.** This supports conversion to/from `f16` only (including vector SIMD) and does not support any `bf16` or arithmetic operations. |
+| `x86`/`x86_64` | `f16c` | This supports conversion to/from `f16` only (including vector SIMD) and does not support any `bf16` or arithmetic operations. |
 | `aarch64` | `fp16` | This supports all operations on `f16` only. |
 
 ### More Documentation

src/binary16/arch.rs

@@ -2,10 +2,7 @@
 use crate::leading_zeros::leading_zeros_u16;
 use core::mem;
 
-#[cfg(all(
-    feature = "use-intrinsics",
-    any(target_arch = "x86", target_arch = "x86_64")
-))]
+#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
 mod x86;
 
 #[cfg(target_arch = "aarch64")]
@@ -18,7 +15,6 @@ macro_rules! convert_fn {
         cfg_if::cfg_if! {
             // Use intrinsics directly when a compile target or using no_std
             if #[cfg(all(
-                feature = "use-intrinsics",
                 any(target_arch = "x86", target_arch = "x86_64"),
                 target_feature = "f16c"
             ))] {
@@ -34,7 +30,6 @@ macro_rules! convert_fn {
 
             // Use CPU feature detection if using std
             else if #[cfg(all(
-                feature = "use-intrinsics",
                 feature = "std",
                 any(target_arch = "x86", target_arch = "x86_64")
             ))] {

src/lib.rs

@@ -56,19 +56,14 @@
 //!
 //! | Architecture | CPU Target Feature | Notes |
 //! | ------------ | ------------------ | ----- |
-//! | `x86`/`x86_64` | `f16c` | **Only on nightly Rust toolchain with `use-intrinsics` cargo feature.** This supports conversion to/from [`f16`] only (including vector SIMD) and does not support any [`bf16`] or arithmetic operations. |
+//! | `x86`/`x86_64` | `f16c` | This supports conversion to/from [`f16`] only (including vector SIMD) and does not support any [`bf16`] or arithmetic operations. |
 //! | `aarch64` | `fp16` | This supports all operations on [`f16`] only. |
 //!
 //! # Cargo Features
 //!
 //! This crate supports a number of optional cargo features. None of these features are enabled by
 //! default, even `std`.
 //!
-//! - **`use-intrinsics`** — Use unstable hardware intrinsics for [`f16`] and [`bf16`] conversions
-//!   if available on the compiler target. By default, only hardware support compatible with the
-//!   Rust stable toolchain will be used, or software emulation otherwise. **Available only on
-//!   Rust nightly channel.**
-//!
 //! - **`alloc`** — Enable use of the [`alloc`] crate when not using the `std` library.
 //!
 //!   Among other functions, this enables the [`vec`] module, which contains zero-copy
@@ -184,13 +179,6 @@
 #![cfg_attr(not(target_arch = "spirv"), warn(missing_debug_implementations))]
 #![allow(clippy::verbose_bit_mask, clippy::cast_lossless)]
 #![cfg_attr(not(feature = "std"), no_std)]
-#![cfg_attr(
-    all(
-        feature = "use-intrinsics",
-        any(target_arch = "x86", target_arch = "x86_64")
-    ),
-    feature(stdsimd)
-)]
 #![doc(html_root_url = "https://docs.rs/half/2.2.1")]
 #![doc(test(attr(deny(warnings), allow(unused))))]
 #![cfg_attr(docsrs, feature(doc_cfg))]