Make f16 and f128 docs clearer on platform support
Co-authored-by: Jubilee <46493976+workingjubilee@users.noreply.github.com> Update library/core/src/primitive_docs.rs Rewrite f16 and f128 hw support comments to match PR feedback I wrote RISC-V allcaps in all cases, and wrote amd64 lowercase in all cases, im not sure if either is the more correct way for either platform, thats just how I normally write them, if theres a precedent elsewhere it should probably be changed to match though. Update library/core/src/primitive_docs.rs Co-authored-by: Jubilee <46493976+workingjubilee@users.noreply.github.com> Update library/core/src/primitive_docs.rs Co-authored-by: Jubilee <46493976+workingjubilee@users.noreply.github.com> Update library/core/src/primitive_docs.rs
This commit is contained in:
parent
e30ad6ff2c
commit
3ef25288a4
@ -1082,8 +1082,12 @@ impl<T> (T,) {}
|
|||||||
/// bits. Please see [the documentation for [`prim@f32`] or [Wikipedia on
|
/// bits. Please see [the documentation for [`prim@f32`] or [Wikipedia on
|
||||||
/// half-precision values][wikipedia] for more information.
|
/// half-precision values][wikipedia] for more information.
|
||||||
///
|
///
|
||||||
/// Note that most major platforms will provide `f16` math support by converting to and from
|
/// Note that most common platforms will not support `f16` in hardware without enabling extra target
|
||||||
/// an `f32`, which is usually fairly performant but will not be as fast as using `f32` directly.
|
/// features, with the notable exception of Apple Silicon (also known as M1, M2, etc.) processors.
|
||||||
|
/// Hardware support on x86-64 requires the avx512fp16 feature, while RISC-V requires Zhf.
|
||||||
|
/// Usually the fallback implementation will be to use `f32` hardware if it exists, and convert
|
||||||
|
/// between `f16` and `f32` when performing math.
|
||||||
|
///
|
||||||
/// *[See also the `std::f16::consts` module](crate::f16::consts).*
|
/// *[See also the `std::f16::consts` module](crate::f16::consts).*
|
||||||
///
|
///
|
||||||
/// [wikipedia]: https://en.wikipedia.org/wiki/Half-precision_floating-point_format
|
/// [wikipedia]: https://en.wikipedia.org/wiki/Half-precision_floating-point_format
|
||||||
@ -1183,12 +1187,15 @@ mod prim_f64 {}
|
|||||||
/// as many bits as `f64`. Please see [the documentation for [`prim@f32`] or [Wikipedia on
|
/// as many bits as `f64`. Please see [the documentation for [`prim@f32`] or [Wikipedia on
|
||||||
/// quad-precision values][wikipedia] for more information.
|
/// quad-precision values][wikipedia] for more information.
|
||||||
///
|
///
|
||||||
/// Note that most major platforms do not have hardware support for `f128`, in which case a
|
/// Note that no platforms have hardware support for `f128` without enabling target specific features
|
||||||
/// software implementation will be used. This can be significantly slower than using `f64`.
|
/// (and [only some consumer level hardware has support][wikipedia-support], for example RISC-V has support, but
|
||||||
|
/// neither amd64 nor aarch64 has support), in which case a software implementation will be used. This can be
|
||||||
|
/// significantly slower than using `f64`.
|
||||||
///
|
///
|
||||||
/// *[See also the `std::f128::consts` module](crate::f128::consts).*
|
/// *[See also the `std::f128::consts` module](crate::f128::consts).*
|
||||||
///
|
///
|
||||||
/// [wikipedia]: https://en.wikipedia.org/wiki/Quadruple-precision_floating-point_format
|
/// [wikipedia]: https://en.wikipedia.org/wiki/Quadruple-precision_floating-point_format
|
||||||
|
/// [wikipedia-support]: https://en.wikipedia.org/wiki/Quadruple-precision_floating-point_format#Hardware_support
|
||||||
#[unstable(feature = "f128", issue = "116909")]
|
#[unstable(feature = "f128", issue = "116909")]
|
||||||
mod prim_f128 {}
|
mod prim_f128 {}
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user