Skip to content

Commit 3fd8c64

Browse files
committed
doc note that f16 and f128 hardware support is limited
1 parent f96442b commit 3fd8c64

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

library/core/src/primitive_docs.rs

+6
Original file line numberDiff line numberDiff line change
@@ -1082,6 +1082,9 @@ impl<T> (T,) {}
10821082
/// bits. Please see [the documentation for [`prim@f32`] or [Wikipedia on
10831083
/// half-precision values][wikipedia] for more information.
10841084
///
1085+
/// Note that not all major platforms have hardware support for f16, in which case a
1086+
/// software implementation will be used. This may be slower than expected.
1087+
///
10851088
/// *[See also the `std::f16::consts` module](crate::f16::consts).*
10861089
///
10871090
/// [wikipedia]: https://en.wikipedia.org/wiki/Half-precision_floating-point_format
@@ -1181,6 +1184,9 @@ mod prim_f64 {}
11811184
/// as many bits as `f64`. Please see [the documentation for [`prim@f32`] or [Wikipedia on
11821185
/// quad-precision values][wikipedia] for more information.
11831186
///
1187+
/// Note that not all major platforms have hardware support for f128, in which case a
1188+
/// software implementation will be used. This may be slower than expected.
1189+
///
11841190
/// *[See also the `std::f128::consts` module](crate::f128::consts).*
11851191
///
11861192
/// [wikipedia]: https://en.wikipedia.org/wiki/Quadruple-precision_floating-point_format

0 commit comments

Comments
 (0)