Repository files navigation

This crate implements a half-precision floating pointf16 type for Rust implementing the IEEE754-2008 standardbinary16a.k.a "half" format, as well as abf16 type implementing thebfloat16 format.

Thef16 andbf16 types attempt to match existing Rust floating point type functionality where possible, and provides both conversion operations (such as to/fromf32 andf64) and basicarithmetic operations. Hardware support for these operations will be used whenever hardware supportis available—either through instrinsics or targeted assembly—although a nightly Rust toolchain maybe required for some hardware.

This crate providesno_std support so can easily be used in embedded code where a smaller float format is most useful.

Requires Rust 1.81 or greater. If you need support for older versions of Rust, use previousversions of this crate.

See thecrate documentation for more details.

• alloc — Enable use of thealloc crate when not usingthestd library.

  This enables thevec module, which contains zero-copy conversions for theVec type. Thisallows fast conversion between rawVec<u16> bits andVec<f16> orVec<bf16> arrays, and viceversa.

• std — Enable features that depend on the Ruststd library, including everything in thealloc feature.

  Enabling thestd feature enables runtime CPU feature detection of hardware support.Without this feature detection, harware is only used when compiler target supports them.

• serde - ImplementSerialize andDeserialize traits forf16 andbf16. This adds adependency on theserde crate.

• num-traits — EnableToPrimitive,FromPrimitive,ToBytes,FromBytes,Num,Float,FloatCore,Signed, andBounded trait implementations from thenum-traits crate.

• bytemuck — EnableZeroable andPod trait implementations from thebytemuck crate.

• rand_distr — Enable sampling from distributions likeStandardUniform andStandardNormalfrom therand_distr crate.

• rkyv -- Enable zero-copy deserializtion withrkyv crate.

• aribtrary -- Enable fuzzing support witharbitrarycrate by implementingArbitrary trait.

• nightly -- Enable nightly-only features (currentlyloongarch64 intrinsics).

The following list details hardware support for floating point types in this crate. When usingstdlibrary, runtime CPU target detection will be used. To get the most performance benefits, compilefor specific CPU features which avoids the runtime overhead and works in ano_std environment.

• Crate API Reference
• Latest Changes

All files in this library are dual-licensed and distributed under the terms of either of:

• MIT License(http://opensource.org/licenses/MIT)
• Apache License, Version 2.0(http://www.apache.org/licenses/LICENSE-2.0)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in thework by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without anyadditional terms or conditions.