about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJubilee Young <workingjubilee@gmail.com>2021-04-02 09:11:24 -0700
committerJubilee Young <workingjubilee@gmail.com>2021-04-02 09:11:27 -0700
commit331230fabff28d2c883967e2ac4ef02eaea4db5c (patch)
treed833cff6ee3b40352bb76800868d7f420b70d76b
parentdd1a5e41ad0763cf8f57eba2a92528b895dc9378 (diff)
downloadrust-331230fabff28d2c883967e2ac4ef02eaea4db5c.tar.gz
rust-331230fabff28d2c883967e2ac4ef02eaea4db5c.zip
Explain why to use saturation
-rw-r--r--crates/core_simd/src/math.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/crates/core_simd/src/math.rs b/crates/core_simd/src/math.rs
index 0d9d6235356..eb46feb5c4b 100644
--- a/crates/core_simd/src/math.rs
+++ b/crates/core_simd/src/math.rs
@@ -80,6 +80,7 @@ macro_rules! impl_int_arith {
             }
 
             /// Lanewise saturating absolute value, implemented in Rust.
+            /// As abs(), except the MIN value becomes MAX instead of itself.
             ///
             /// # Examples
             /// # use core_simd::*;
@@ -99,6 +100,7 @@ macro_rules! impl_int_arith {
             }
 
             /// Lanewise saturating negation, implemented in Rust.
+            /// As neg(), except the MIN value becomes MAX instead of itself.
             ///
             /// # Examples
             /// # use core_simd::*;