Skip to content

Commit 1fd7de0

Browse files
Clarify UB and improve grammar
Co-authored-by: Ralf Jung <post@ralfj.de>
1 parent ef4cf01 commit 1fd7de0

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

library/core/src/intrinsics/simd.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ extern "platform-intrinsic" {
3636
/// Additionally for signed integers, `<int>::MIN / -1` is undefined behavior.
3737
pub fn simd_rem<T>(lhs: T, rhs: T) -> T;
3838

39-
/// Elementwise vector left shift.
39+
/// Elementwise vector left shift, with UB on overflow.
4040
///
4141
/// Shift `lhs` left by `rhs`, shifting in sign bits for signed types.
4242
///
@@ -47,7 +47,7 @@ extern "platform-intrinsic" {
4747
/// Each element of `rhs` must be less than `<int>::BITS`.
4848
pub fn simd_shl<T>(lhs: T, rhs: T) -> T;
4949

50-
/// Elementwise vector right shift.
50+
/// Elementwise vector right shift, with UB on overflow.
5151
///
5252
/// Shift `lhs` right by `rhs`, shifting in sign bits for signed types.
5353
///
@@ -75,11 +75,11 @@ extern "platform-intrinsic" {
7575

7676
/// Numerically cast a vector, elementwise.
7777
///
78-
/// When casting floats to integers, the result is truncated.
78+
/// When casting floats to integers, the result is truncated. Out-of-bounds result lead to UB.
7979
/// When casting integers to floats, the result is rounded.
8080
/// Otherwise, truncates or extends the value, maintaining the sign for signed integers.
8181
///
82-
/// `T` and `U` be a vectors of integer or floating point primitive types, and must have the
82+
/// `T` and `U` must be vectors of integer or floating point primitive types, and must have the
8383
/// same length.
8484
///
8585
/// # Safety

0 commit comments

Comments
 (0)